diff --git a/Avalara/SDK/api/A1099/V2/companies_w9_api.py b/Avalara/SDK/api/A1099/V2/companies_w9_api.py index 3f29ebc..1660087 100644 --- a/Avalara/SDK/api/A1099/V2/companies_w9_api.py +++ b/Avalara/SDK/api/A1099/V2/companies_w9_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -43,8 +43,8 @@ from pydantic import Field, StrictBool, StrictInt, StrictStr from typing import Optional from typing_extensions import Annotated +from Avalara.SDK.models.A1099.V2.company_request import CompanyRequest from Avalara.SDK.models.A1099.V2.company_response import CompanyResponse -from Avalara.SDK.models.A1099.V2.create_company_request import CreateCompanyRequest from Avalara.SDK.models.A1099.V2.paginated_query_result_model_company_response import PaginatedQueryResultModelCompanyResponse from Avalara.SDK.exceptions import ApiTypeError, ApiValueError, ApiException from Avalara.SDK.oauth_helper.AvalaraSdkOauthUtils import avalara_retry_oauth @@ -60,7 +60,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.create_company_endpoint = _Endpoint( @@ -79,7 +79,7 @@ def __set_configuration(self, api_client): 'avalara_version', 'x_correlation_id', 'x_avalara_client', - 'create_company_request', + 'company_request', ], 'required': [ 'avalara_version', @@ -103,8 +103,8 @@ def __set_configuration(self, api_client): (str,), 'x_avalara_client': (str,), - 'create_company_request': - (CreateCompanyRequest,), + 'company_request': + (CompanyRequest,), }, 'attribute_map': { 'avalara_version': 'avalara-version', @@ -115,7 +115,7 @@ def __set_configuration(self, api_client): 'avalara_version': 'header', 'x_correlation_id': 'header', 'x_avalara_client': 'header', - 'create_company_request': 'body', + 'company_request': 'body', }, 'collection_format_map': { } @@ -386,7 +386,7 @@ def __set_configuration(self, api_client): 'avalara_version', 'x_correlation_id', 'x_avalara_client', - 'create_company_request', + 'company_request', ], 'required': [ 'id', @@ -413,8 +413,8 @@ def __set_configuration(self, api_client): (str,), 'x_avalara_client': (str,), - 'create_company_request': - (CreateCompanyRequest,), + 'company_request': + (CompanyRequest,), }, 'attribute_map': { 'id': 'id', @@ -427,7 +427,7 @@ def __set_configuration(self, api_client): 'avalara_version': 'header', 'x_correlation_id': 'header', 'x_avalara_client': 'header', - 'create_company_request': 'body', + 'company_request': 'body', }, 'collection_format_map': { } @@ -469,7 +469,7 @@ def create_company( Keyword Args: x_correlation_id (str): Unique correlation Id in a GUID format. [optional] x_avalara_client (str): Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .. [optional] - create_company_request (CreateCompanyRequest): The company to create. [optional] + company_request (CompanyRequest): The company to create. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -760,7 +760,7 @@ def update_company( Keyword Args: x_correlation_id (str): Unique correlation Id in a GUID format. [optional] x_avalara_client (str): Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .. [optional] - create_company_request (CreateCompanyRequest): The updated company data. [optional] + company_request (CompanyRequest): The updated company data. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/Avalara/SDK/api/A1099/V2/forms1099_api.py b/Avalara/SDK/api/A1099/V2/forms1099_api.py index e235bbf..f527e06 100644 --- a/Avalara/SDK/api/A1099/V2/forms1099_api.py +++ b/Avalara/SDK/api/A1099/V2/forms1099_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -61,7 +61,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.bulk_upsert1099_forms_endpoint = _Endpoint( @@ -610,7 +610,7 @@ def bulk_upsert1099_forms( ): """Create or update multiple 1099/1095/W2/1042S forms # noqa: E501 - This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. Maximum of 5000 forms can be processed in a single bulk request. # noqa: E501 + This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. Maximum of 5000 forms can be processed in a single bulk request. **Date Scheduling Rules:** If federalEfileDate, stateEfileDate, or recipientEdeliveryDate are between current date and beginning of blackout period, scheduled to that date. If dates are in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate. Set dates to null to leave unscheduled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -681,7 +681,7 @@ def create1099_form( ): """Create a 1099/1095/W2/1042S form # noqa: E501 - Create a 1099/1095/W2/1042S form. # noqa: E501 + Create a 1099/1095/W2/1042S form. **Date Scheduling Rules:** If federalEfileDate, stateEfileDate, or recipientEdeliveryDate are between current date and beginning of blackout period, scheduled to that date. If dates are in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate. Set dates to null to leave unscheduled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1044,7 +1044,7 @@ def update1099_form( ): """Update a 1099/1095/W2/1042S form # noqa: E501 - Update a 1099/1095/W2/1042S form. # noqa: E501 + Update a 1099/1095/W2/1042S form. **Date Update Rules:** Possible to update scheduled dates (same validation rules apply). Cannot change from scheduled to unscheduled status - must delete form and create new one. If dates are between current date and blackout period, scheduled to that date. If dates are in past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/Avalara/SDK/api/A1099/V2/forms_w9_api.py b/Avalara/SDK/api/A1099/V2/forms_w9_api.py index a80f5a8..7ca6fb8 100644 --- a/Avalara/SDK/api/A1099/V2/forms_w9_api.py +++ b/Avalara/SDK/api/A1099/V2/forms_w9_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -46,7 +46,6 @@ from Avalara.SDK.models.A1099.V2.create_and_send_w9_form_email_request import CreateAndSendW9FormEmailRequest from Avalara.SDK.models.A1099.V2.create_w9_form201_response import CreateW9Form201Response from Avalara.SDK.models.A1099.V2.create_w9_form_request import CreateW9FormRequest -from Avalara.SDK.models.A1099.V2.iw9_form_data_models_one_of import IW9FormDataModelsOneOf from Avalara.SDK.models.A1099.V2.paginated_query_result_model_w9_form_base_response import PaginatedQueryResultModelW9FormBaseResponse from Avalara.SDK.exceptions import ApiTypeError, ApiValueError, ApiException from Avalara.SDK.oauth_helper.AvalaraSdkOauthUtils import avalara_retry_oauth @@ -62,7 +61,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.create_and_send_w9_form_email_endpoint = _Endpoint( @@ -515,7 +514,7 @@ def __set_configuration(self, api_client): ) self.update_w9_form_endpoint = _Endpoint( settings={ - 'response_type': (IW9FormDataModelsOneOf,), + 'response_type': (CreateW9Form201Response,), 'auth': [ 'bearer' ], @@ -530,7 +529,7 @@ def __set_configuration(self, api_client): 'avalara_version', 'x_correlation_id', 'x_avalara_client', - 'iw9_form_data_models_one_of', + 'create_w9_form_request', ], 'required': [ 'id', @@ -557,8 +556,8 @@ def __set_configuration(self, api_client): (str,), 'x_avalara_client': (str,), - 'iw9_form_data_models_one_of': - (IW9FormDataModelsOneOf,), + 'create_w9_form_request': + (CreateW9FormRequest,), }, 'attribute_map': { 'id': 'id', @@ -571,7 +570,7 @@ def __set_configuration(self, api_client): 'avalara_version': 'header', 'x_correlation_id': 'header', 'x_avalara_client': 'header', - 'iw9_form_data_models_one_of': 'body', + 'create_w9_form_request': 'body', }, 'collection_format_map': { } @@ -1037,7 +1036,7 @@ def send_w9_form_email( ): """Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form # noqa: E501 - Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request. # noqa: E501 + Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1123,7 +1122,7 @@ def update_w9_form( Keyword Args: x_correlation_id (str): Unique correlation Id in a GUID format. [optional] x_avalara_client (str): Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .. [optional] - iw9_form_data_models_one_of (IW9FormDataModelsOneOf): Form to be updated. [optional] + create_w9_form_request (CreateW9FormRequest): Form to be updated. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1145,7 +1144,7 @@ def update_w9_form( async_req (bool): execute request asynchronously Returns: - IW9FormDataModelsOneOf + CreateW9Form201Response If the method is called asynchronously, returns the request thread. """ diff --git a/Avalara/SDK/api/A1099/V2/issuers1099_api.py b/Avalara/SDK/api/A1099/V2/issuers1099_api.py index 0cd4390..4d2bf1c 100644 --- a/Avalara/SDK/api/A1099/V2/issuers1099_api.py +++ b/Avalara/SDK/api/A1099/V2/issuers1099_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -43,7 +43,7 @@ from pydantic import Field, StrictBool, StrictInt, StrictStr from typing import Optional from typing_extensions import Annotated -from Avalara.SDK.models.A1099.V2.create_issuer_request import CreateIssuerRequest +from Avalara.SDK.models.A1099.V2.issuer_request import IssuerRequest from Avalara.SDK.models.A1099.V2.issuer_response import IssuerResponse from Avalara.SDK.models.A1099.V2.paginated_query_result_model_issuer_response import PaginatedQueryResultModelIssuerResponse from Avalara.SDK.exceptions import ApiTypeError, ApiValueError, ApiException @@ -60,7 +60,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.create_issuer_endpoint = _Endpoint( @@ -79,7 +79,7 @@ def __set_configuration(self, api_client): 'avalara_version', 'x_correlation_id', 'x_avalara_client', - 'create_issuer_request', + 'issuer_request', ], 'required': [ 'avalara_version', @@ -103,8 +103,8 @@ def __set_configuration(self, api_client): (str,), 'x_avalara_client': (str,), - 'create_issuer_request': - (CreateIssuerRequest,), + 'issuer_request': + (IssuerRequest,), }, 'attribute_map': { 'avalara_version': 'avalara-version', @@ -115,7 +115,7 @@ def __set_configuration(self, api_client): 'avalara_version': 'header', 'x_correlation_id': 'header', 'x_avalara_client': 'header', - 'create_issuer_request': 'body', + 'issuer_request': 'body', }, 'collection_format_map': { } @@ -386,7 +386,7 @@ def __set_configuration(self, api_client): 'avalara_version', 'x_correlation_id', 'x_avalara_client', - 'create_issuer_request', + 'issuer_request', ], 'required': [ 'id', @@ -413,8 +413,8 @@ def __set_configuration(self, api_client): (str,), 'x_avalara_client': (str,), - 'create_issuer_request': - (CreateIssuerRequest,), + 'issuer_request': + (IssuerRequest,), }, 'attribute_map': { 'id': 'id', @@ -427,7 +427,7 @@ def __set_configuration(self, api_client): 'avalara_version': 'header', 'x_correlation_id': 'header', 'x_avalara_client': 'header', - 'create_issuer_request': 'body', + 'issuer_request': 'body', }, 'collection_format_map': { } @@ -469,7 +469,7 @@ def create_issuer( Keyword Args: x_correlation_id (str): Unique correlation Id in a GUID format. [optional] x_avalara_client (str): Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .. [optional] - create_issuer_request (CreateIssuerRequest): The issuer to create. [optional] + issuer_request (IssuerRequest): The issuer to create. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -760,7 +760,7 @@ def update_issuer( Keyword Args: x_correlation_id (str): Unique correlation Id in a GUID format. [optional] x_avalara_client (str): Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .. [optional] - create_issuer_request (CreateIssuerRequest): The issuer to update. [optional] + issuer_request (IssuerRequest): The issuer to update. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/Avalara/SDK/api/A1099/V2/jobs_api.py b/Avalara/SDK/api/A1099/V2/jobs_api.py index 79a135a..31275df 100644 --- a/Avalara/SDK/api/A1099/V2/jobs_api.py +++ b/Avalara/SDK/api/A1099/V2/jobs_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -58,7 +58,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.get_job_endpoint = _Endpoint( diff --git a/Avalara/SDK/api/EInvoicing/V1/data_input_fields_api.py b/Avalara/SDK/api/EInvoicing/V1/data_input_fields_api.py index 042e743..159ffe4 100644 --- a/Avalara/SDK/api/EInvoicing/V1/data_input_fields_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/data_input_fields_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -58,7 +58,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.get_data_input_fields_endpoint = _Endpoint( diff --git a/Avalara/SDK/api/EInvoicing/V1/documents_api.py b/Avalara/SDK/api/EInvoicing/V1/documents_api.py index c0e9dce..fbd7396 100644 --- a/Avalara/SDK/api/EInvoicing/V1/documents_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/documents_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -64,7 +64,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.download_document_endpoint = _Endpoint( diff --git a/Avalara/SDK/api/EInvoicing/V1/interop_api.py b/Avalara/SDK/api/EInvoicing/V1/interop_api.py index c7a3b68..1f7eb4d 100644 --- a/Avalara/SDK/api/EInvoicing/V1/interop_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/interop_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -58,7 +58,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.submit_interop_document_endpoint = _Endpoint( diff --git a/Avalara/SDK/api/EInvoicing/V1/mandates_api.py b/Avalara/SDK/api/EInvoicing/V1/mandates_api.py index f72dfe4..4fbc6fd 100644 --- a/Avalara/SDK/api/EInvoicing/V1/mandates_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/mandates_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -59,7 +59,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.get_mandate_data_input_fields_endpoint = _Endpoint( diff --git a/Avalara/SDK/api/EInvoicing/V1/subscriptions_api.py b/Avalara/SDK/api/EInvoicing/V1/subscriptions_api.py index dcf95ed..143e8f5 100644 --- a/Avalara/SDK/api/EInvoicing/V1/subscriptions_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/subscriptions_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -61,7 +61,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.create_webhook_subscription_endpoint = _Endpoint( diff --git a/Avalara/SDK/api/EInvoicing/V1/tax_identifiers_api.py b/Avalara/SDK/api/EInvoicing/V1/tax_identifiers_api.py index 1e397be..fecc957 100644 --- a/Avalara/SDK/api/EInvoicing/V1/tax_identifiers_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/tax_identifiers_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -60,7 +60,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.tax_identifier_schema_by_country_endpoint = _Endpoint( diff --git a/Avalara/SDK/api/EInvoicing/V1/trading_partners_api.py b/Avalara/SDK/api/EInvoicing/V1/trading_partners_api.py index 9e5815b..3cbdf14 100644 --- a/Avalara/SDK/api/EInvoicing/V1/trading_partners_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/trading_partners_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -66,7 +66,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") self.api_client = api_client self.batch_search_participants_endpoint = _Endpoint( diff --git a/Avalara/SDK/api_client.py b/Avalara/SDK/api_client.py index 50990ba..edb3b9b 100644 --- a/Avalara/SDK/api_client.py +++ b/Avalara/SDK/api_client.py @@ -186,7 +186,12 @@ def __call_api( header_params = header_params or {} header_params.update(self.default_headers) - header_params['X-Avalara-Client'] = self.client_id + # Always set X-Avalara-SDK-Client to SDK info + header_params['X-Avalara-SDK-Client'] = self.client_id + + # If X-Avalara-Client is null/empty, set it to SDK info as well + if 'X-Avalara-Client' not in header_params or not header_params['X-Avalara-Client'] or not header_params['X-Avalara-Client'].strip(): + header_params['X-Avalara-Client'] = self.client_id if self.cookie: header_params['Cookie'] = self.cookie if header_params: diff --git a/Avalara/SDK/models/A1099/V2/company_base.py b/Avalara/SDK/models/A1099/V2/company_base.py new file mode 100644 index 0000000..077c7d5 --- /dev/null +++ b/Avalara/SDK/models/A1099/V2/company_base.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara 1099 & W-9 API Definition + ## 🔐 Authentication Generate a **license key** from: *[Avalara Portal](https://www.avalara.com/us/en/signin.html) → Settings → License and API Keys*. [More on authentication methods](https://developer.avalara.com/avatax-dm-combined-erp/common-setup/authentication/authentication-methods/) [Test your credentials](https://developer.avalara.com/avatax/test-credentials/) ## 📘 API & SDK Documentation [Avalara SDK (.NET) on GitHub](https://github.com/avadev/Avalara-SDK-DotNet#avalarasdk--the-unified-c-library-for-next-gen-avalara-services) [Code Examples – 1099 API](https://github.com/avadev/Avalara-SDK-DotNet/blob/main/docs/A1099/V2/Class1099IssuersApi.md#call1099issuersget) + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 25.9.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class CompanyBase(BaseModel): + """ + CompanyBase + """ # noqa: E501 + name: Optional[StrictStr] = Field(description="Legal name. Not the DBA name.") + dba_name: Optional[StrictStr] = Field(default=None, description="Doing Business As (DBA) name or continuation of a long legal name.", alias="dbaName") + email: Optional[StrictStr] = Field(description="Contact email address. For inquiries by vendors/employees.") + address: Optional[StrictStr] = Field(description="Address.") + city: Optional[StrictStr] = Field(description="City.") + state: Optional[StrictStr] = Field(default=None, description="Two-letter US state or Canadian province code (required for US/CA addresses).") + zip: Optional[StrictStr] = Field(description="ZIP/postal code.") + telephone: Optional[StrictStr] = Field(description="Contact phone number (must contain at least 10 digits, max 15 characters).") + tin: Optional[StrictStr] = Field(description="Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies).") + reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") + do_tin_match: Optional[StrictBool] = Field(default=None, description="Indicates whether the company authorizes IRS TIN matching.", alias="doTinMatch") + group_name: Optional[StrictStr] = Field(default=None, description="Group name for organizing companies (creates or finds group by name).", alias="groupName") + foreign_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="foreignProvince") + country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") + resend_requests: Optional[StrictBool] = Field(default=None, description="Boolean to enable automatic reminder emails (default: false).", alias="resendRequests") + resend_interval_days: Optional[StrictInt] = Field(default=None, description="Days between reminder emails (7-365, required if resendRequests is true).", alias="resendIntervalDays") + max_reminder_attempts: Optional[StrictInt] = Field(default=None, description="Maximum number of reminder attempts (1-52, required if resendRequests is true).", alias="maxReminderAttempts") + __properties: ClassVar[List[str]] = ["name", "dbaName", "email", "address", "city", "state", "zip", "telephone", "tin", "referenceId", "doTinMatch", "groupName", "foreignProvince", "countryCode", "resendRequests", "resendIntervalDays", "maxReminderAttempts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CompanyBase from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + # set to None if dba_name (nullable) is None + # and model_fields_set contains the field + if self.dba_name is None and "dba_name" in self.model_fields_set: + _dict['dbaName'] = None + + # set to None if email (nullable) is None + # and model_fields_set contains the field + if self.email is None and "email" in self.model_fields_set: + _dict['email'] = None + + # set to None if address (nullable) is None + # and model_fields_set contains the field + if self.address is None and "address" in self.model_fields_set: + _dict['address'] = None + + # set to None if city (nullable) is None + # and model_fields_set contains the field + if self.city is None and "city" in self.model_fields_set: + _dict['city'] = None + + # set to None if state (nullable) is None + # and model_fields_set contains the field + if self.state is None and "state" in self.model_fields_set: + _dict['state'] = None + + # set to None if zip (nullable) is None + # and model_fields_set contains the field + if self.zip is None and "zip" in self.model_fields_set: + _dict['zip'] = None + + # set to None if telephone (nullable) is None + # and model_fields_set contains the field + if self.telephone is None and "telephone" in self.model_fields_set: + _dict['telephone'] = None + + # set to None if tin (nullable) is None + # and model_fields_set contains the field + if self.tin is None and "tin" in self.model_fields_set: + _dict['tin'] = None + + # set to None if reference_id (nullable) is None + # and model_fields_set contains the field + if self.reference_id is None and "reference_id" in self.model_fields_set: + _dict['referenceId'] = None + + # set to None if do_tin_match (nullable) is None + # and model_fields_set contains the field + if self.do_tin_match is None and "do_tin_match" in self.model_fields_set: + _dict['doTinMatch'] = None + + # set to None if group_name (nullable) is None + # and model_fields_set contains the field + if self.group_name is None and "group_name" in self.model_fields_set: + _dict['groupName'] = None + + # set to None if foreign_province (nullable) is None + # and model_fields_set contains the field + if self.foreign_province is None and "foreign_province" in self.model_fields_set: + _dict['foreignProvince'] = None + + # set to None if country_code (nullable) is None + # and model_fields_set contains the field + if self.country_code is None and "country_code" in self.model_fields_set: + _dict['countryCode'] = None + + # set to None if resend_requests (nullable) is None + # and model_fields_set contains the field + if self.resend_requests is None and "resend_requests" in self.model_fields_set: + _dict['resendRequests'] = None + + # set to None if resend_interval_days (nullable) is None + # and model_fields_set contains the field + if self.resend_interval_days is None and "resend_interval_days" in self.model_fields_set: + _dict['resendIntervalDays'] = None + + # set to None if max_reminder_attempts (nullable) is None + # and model_fields_set contains the field + if self.max_reminder_attempts is None and "max_reminder_attempts" in self.model_fields_set: + _dict['maxReminderAttempts'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CompanyBase from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "dbaName": obj.get("dbaName"), + "email": obj.get("email"), + "address": obj.get("address"), + "city": obj.get("city"), + "state": obj.get("state"), + "zip": obj.get("zip"), + "telephone": obj.get("telephone"), + "tin": obj.get("tin"), + "referenceId": obj.get("referenceId"), + "doTinMatch": obj.get("doTinMatch"), + "groupName": obj.get("groupName"), + "foreignProvince": obj.get("foreignProvince"), + "countryCode": obj.get("countryCode"), + "resendRequests": obj.get("resendRequests"), + "resendIntervalDays": obj.get("resendIntervalDays"), + "maxReminderAttempts": obj.get("maxReminderAttempts") + }) + return _obj + + diff --git a/Avalara/SDK/models/A1099/V2/company_request.py b/Avalara/SDK/models/A1099/V2/company_request.py new file mode 100644 index 0000000..291912a --- /dev/null +++ b/Avalara/SDK/models/A1099/V2/company_request.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara 1099 & W-9 API Definition + ## 🔐 Authentication Generate a **license key** from: *[Avalara Portal](https://www.avalara.com/us/en/signin.html) → Settings → License and API Keys*. [More on authentication methods](https://developer.avalara.com/avatax-dm-combined-erp/common-setup/authentication/authentication-methods/) [Test your credentials](https://developer.avalara.com/avatax/test-credentials/) ## 📘 API & SDK Documentation [Avalara SDK (.NET) on GitHub](https://github.com/avadev/Avalara-SDK-DotNet#avalarasdk--the-unified-c-library-for-next-gen-avalara-services) [Code Examples – 1099 API](https://github.com/avadev/Avalara-SDK-DotNet/blob/main/docs/A1099/V2/Class1099IssuersApi.md#call1099issuersget) + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 25.9.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class CompanyRequest(BaseModel): + """ + CompanyRequest + """ # noqa: E501 + name: Optional[StrictStr] = Field(description="Legal name. Not the DBA name.") + dba_name: Optional[StrictStr] = Field(default=None, description="Doing Business As (DBA) name or continuation of a long legal name.", alias="dbaName") + email: Optional[StrictStr] = Field(description="Contact email address. For inquiries by vendors/employees.") + address: Optional[StrictStr] = Field(description="Address.") + city: Optional[StrictStr] = Field(description="City.") + state: Optional[StrictStr] = Field(default=None, description="Two-letter US state or Canadian province code (required for US/CA addresses).") + zip: Optional[StrictStr] = Field(description="ZIP/postal code.") + telephone: Optional[StrictStr] = Field(description="Contact phone number (must contain at least 10 digits, max 15 characters).") + tin: Optional[StrictStr] = Field(description="Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies).") + reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") + do_tin_match: Optional[StrictBool] = Field(default=None, description="Indicates whether the company authorizes IRS TIN matching.", alias="doTinMatch") + group_name: Optional[StrictStr] = Field(default=None, description="Group name for organizing companies (creates or finds group by name).", alias="groupName") + foreign_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="foreignProvince") + country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") + resend_requests: Optional[StrictBool] = Field(default=None, description="Boolean to enable automatic reminder emails (default: false).", alias="resendRequests") + resend_interval_days: Optional[StrictInt] = Field(default=None, description="Days between reminder emails (7-365, required if resendRequests is true).", alias="resendIntervalDays") + max_reminder_attempts: Optional[StrictInt] = Field(default=None, description="Maximum number of reminder attempts (1-52, required if resendRequests is true).", alias="maxReminderAttempts") + __properties: ClassVar[List[str]] = ["name", "dbaName", "email", "address", "city", "state", "zip", "telephone", "tin", "referenceId", "doTinMatch", "groupName", "foreignProvince", "countryCode", "resendRequests", "resendIntervalDays", "maxReminderAttempts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CompanyRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + # set to None if dba_name (nullable) is None + # and model_fields_set contains the field + if self.dba_name is None and "dba_name" in self.model_fields_set: + _dict['dbaName'] = None + + # set to None if email (nullable) is None + # and model_fields_set contains the field + if self.email is None and "email" in self.model_fields_set: + _dict['email'] = None + + # set to None if address (nullable) is None + # and model_fields_set contains the field + if self.address is None and "address" in self.model_fields_set: + _dict['address'] = None + + # set to None if city (nullable) is None + # and model_fields_set contains the field + if self.city is None and "city" in self.model_fields_set: + _dict['city'] = None + + # set to None if state (nullable) is None + # and model_fields_set contains the field + if self.state is None and "state" in self.model_fields_set: + _dict['state'] = None + + # set to None if zip (nullable) is None + # and model_fields_set contains the field + if self.zip is None and "zip" in self.model_fields_set: + _dict['zip'] = None + + # set to None if telephone (nullable) is None + # and model_fields_set contains the field + if self.telephone is None and "telephone" in self.model_fields_set: + _dict['telephone'] = None + + # set to None if tin (nullable) is None + # and model_fields_set contains the field + if self.tin is None and "tin" in self.model_fields_set: + _dict['tin'] = None + + # set to None if reference_id (nullable) is None + # and model_fields_set contains the field + if self.reference_id is None and "reference_id" in self.model_fields_set: + _dict['referenceId'] = None + + # set to None if do_tin_match (nullable) is None + # and model_fields_set contains the field + if self.do_tin_match is None and "do_tin_match" in self.model_fields_set: + _dict['doTinMatch'] = None + + # set to None if group_name (nullable) is None + # and model_fields_set contains the field + if self.group_name is None and "group_name" in self.model_fields_set: + _dict['groupName'] = None + + # set to None if foreign_province (nullable) is None + # and model_fields_set contains the field + if self.foreign_province is None and "foreign_province" in self.model_fields_set: + _dict['foreignProvince'] = None + + # set to None if country_code (nullable) is None + # and model_fields_set contains the field + if self.country_code is None and "country_code" in self.model_fields_set: + _dict['countryCode'] = None + + # set to None if resend_requests (nullable) is None + # and model_fields_set contains the field + if self.resend_requests is None and "resend_requests" in self.model_fields_set: + _dict['resendRequests'] = None + + # set to None if resend_interval_days (nullable) is None + # and model_fields_set contains the field + if self.resend_interval_days is None and "resend_interval_days" in self.model_fields_set: + _dict['resendIntervalDays'] = None + + # set to None if max_reminder_attempts (nullable) is None + # and model_fields_set contains the field + if self.max_reminder_attempts is None and "max_reminder_attempts" in self.model_fields_set: + _dict['maxReminderAttempts'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CompanyRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "dbaName": obj.get("dbaName"), + "email": obj.get("email"), + "address": obj.get("address"), + "city": obj.get("city"), + "state": obj.get("state"), + "zip": obj.get("zip"), + "telephone": obj.get("telephone"), + "tin": obj.get("tin"), + "referenceId": obj.get("referenceId"), + "doTinMatch": obj.get("doTinMatch"), + "groupName": obj.get("groupName"), + "foreignProvince": obj.get("foreignProvince"), + "countryCode": obj.get("countryCode"), + "resendRequests": obj.get("resendRequests"), + "resendIntervalDays": obj.get("resendIntervalDays"), + "maxReminderAttempts": obj.get("maxReminderAttempts") + }) + return _obj + + diff --git a/Avalara/SDK/models/A1099/V2/company_response.py b/Avalara/SDK/models/A1099/V2/company_response.py index 95a67d8..8c965c1 100644 --- a/Avalara/SDK/models/A1099/V2/company_response.py +++ b/Avalara/SDK/models/A1099/V2/company_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/covered_individual.py b/Avalara/SDK/models/A1099/V2/covered_individual.py index d5bfe33..b3ce25f 100644 --- a/Avalara/SDK/models/A1099/V2/covered_individual.py +++ b/Avalara/SDK/models/A1099/V2/covered_individual.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/create_and_send_w9_form_email_request.py b/Avalara/SDK/models/A1099/V2/create_and_send_w9_form_email_request.py index f4caa6d..9e18ec5 100644 --- a/Avalara/SDK/models/A1099/V2/create_and_send_w9_form_email_request.py +++ b/Avalara/SDK/models/A1099/V2/create_and_send_w9_form_email_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/create_company_request.py b/Avalara/SDK/models/A1099/V2/create_company_request.py index acbb8f2..aa9de39 100644 --- a/Avalara/SDK/models/A1099/V2/create_company_request.py +++ b/Avalara/SDK/models/A1099/V2/create_company_request.py @@ -33,8 +33,8 @@ import pprint from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator from typing import Any, List, Optional -from Avalara.SDK.models.A1099.V2.company_create_update_request_model import CompanyCreateUpdateRequestModel -from Avalara.SDK.models.A1099.V2.company_response import CompanyResponse +from Avalara.SDK.models.A1099.V2.A1099.V2.company_create_update_request_model import CompanyCreateUpdateRequestModel +from Avalara.SDK.models.A1099.V2.A1099.V2.company_response import CompanyResponse from pydantic import StrictStr, Field from typing import Union, List, Set, Optional, Dict from typing_extensions import Literal, Self diff --git a/Avalara/SDK/models/A1099/V2/create_issuer_request.py b/Avalara/SDK/models/A1099/V2/create_issuer_request.py index 390901d..bb2cdb2 100644 --- a/Avalara/SDK/models/A1099/V2/create_issuer_request.py +++ b/Avalara/SDK/models/A1099/V2/create_issuer_request.py @@ -33,8 +33,8 @@ import pprint from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator from typing import Any, List, Optional -from Avalara.SDK.models.A1099.V2.issuer_command import IssuerCommand -from Avalara.SDK.models.A1099.V2.issuer_response import IssuerResponse +from Avalara.SDK.models.A1099.V2.A1099.V2.issuer_command import IssuerCommand +from Avalara.SDK.models.A1099.V2.A1099.V2.issuer_response import IssuerResponse from pydantic import StrictStr, Field from typing import Union, List, Set, Optional, Dict from typing_extensions import Literal, Self diff --git a/Avalara/SDK/models/A1099/V2/create_w9_form201_response.py b/Avalara/SDK/models/A1099/V2/create_w9_form201_response.py index 8c7c606..6cac82d 100644 --- a/Avalara/SDK/models/A1099/V2/create_w9_form201_response.py +++ b/Avalara/SDK/models/A1099/V2/create_w9_form201_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -67,9 +67,6 @@ class CreateW9Form201Response(BaseModel): ) - discriminator_value_class_map: Dict[str, str] = { - } - def __init__(self, *args, **kwargs) -> None: if args: if len(args) > 1: diff --git a/Avalara/SDK/models/A1099/V2/create_w9_form_request.py b/Avalara/SDK/models/A1099/V2/create_w9_form_request.py index 0d83142..76d4f01 100644 --- a/Avalara/SDK/models/A1099/V2/create_w9_form_request.py +++ b/Avalara/SDK/models/A1099/V2/create_w9_form_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/entry_status_response.py b/Avalara/SDK/models/A1099/V2/entry_status_response.py index 466cfc6..702dce7 100644 --- a/Avalara/SDK/models/A1099/V2/entry_status_response.py +++ b/Avalara/SDK/models/A1099/V2/entry_status_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/error_response.py b/Avalara/SDK/models/A1099/V2/error_response.py index aea6c25..ce6e98d 100644 --- a/Avalara/SDK/models/A1099/V2/error_response.py +++ b/Avalara/SDK/models/A1099/V2/error_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/error_response_item.py b/Avalara/SDK/models/A1099/V2/error_response_item.py index 3e56474..310409e 100644 --- a/Avalara/SDK/models/A1099/V2/error_response_item.py +++ b/Avalara/SDK/models/A1099/V2/error_response_item.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/form1042_s.py b/Avalara/SDK/models/A1099/V2/form1042_s.py index 112a2ce..1cce848 100644 --- a/Avalara/SDK/models/A1099/V2/form1042_s.py +++ b/Avalara/SDK/models/A1099/V2/form1042_s.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -49,7 +49,7 @@ class Form1042S(BaseModel): """ Form 1042-S: Foreign Person's U.S. Source Income Subject to Withholding """ # noqa: E501 - tin_type: Optional[StrictStr] = Field(default=None, alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") unique_form_id: Optional[StrictStr] = Field(description="Unique form identifier", alias="uniqueFormId") recipient_date_of_birth: Optional[date] = Field(default=None, description="Recipient's date of birth", alias="recipientDateOfBirth") recipient_giin: Optional[StrictStr] = Field(default=None, description="Recipient's Global Intermediary Identification Number (GIIN). A valid GIIN looks like 'XXXXXX.XXXXX.XX.XXX'.", alias="recipientGiin") @@ -69,16 +69,16 @@ class Form1042S(BaseModel): tax_withheld_other_agents: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Tax withheld by other agents", alias="taxWithheldOtherAgents") amount_repaid: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Amount repaid to recipient", alias="amountRepaid") tax_paid_agent: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Tax paid by withholding agent", alias="taxPaidAgent") - chap3_status_code: Optional[StrictStr] = Field(default=None, description="Chapter 3 status code - Required if WithholdingIndicator is 3 (Chapter 3) Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary", alias="chap3StatusCode") - chap4_status_code: Optional[StrictStr] = Field(default=None, description="Chapter 4 status code. Required if WithholdingIndicator is 4 (Chapter 4). Required if email is specified, must fill either this or RecipientForeignTin. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI", alias="chap4StatusCode") + chap3_status_code: Optional[StrictStr] = Field(default=None, description="Chapter 3 status code - Required if WithholdingIndicator is 3 (Chapter 3). Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary", alias="chap3StatusCode") + chap4_status_code: Optional[StrictStr] = Field(default=None, description="Chapter 4 status code. Required if WithholdingIndicator is 4 (Chapter 4). Required if email is specified, must fill either this or RecipientForeignTin. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI", alias="chap4StatusCode") primary_withholding_agent: Optional[PrimaryWithholdingAgent] = Field(default=None, description="Primary withholding agent information", alias="primaryWithholdingAgent") intermediary_or_flow_through: Optional[IntermediaryOrFlowThrough] = Field(default=None, description="Intermediary or flow-through entity information", alias="intermediaryOrFlowThrough") - type: StrictStr = Field(description="Form type") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") @@ -93,21 +93,21 @@ class Form1042S(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -119,8 +119,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value @field_validator('lob_code') @@ -206,8 +206,8 @@ def chap4_status_code_validate_enum(cls, value): @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value model_config = ConfigDict( @@ -443,6 +443,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1095_b.py b/Avalara/SDK/models/A1099/V2/form1095_b.py index 34206a4..c4cded4 100644 --- a/Avalara/SDK/models/A1099/V2/form1095_b.py +++ b/Avalara/SDK/models/A1099/V2/form1095_b.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -53,18 +53,18 @@ class Form1095B(BaseModel): employee_last_name: Optional[StrictStr] = Field(description="Employee's last name", alias="employeeLastName") employee_name_suffix: Optional[StrictStr] = Field(default=None, description="Employee's name suffix", alias="employeeNameSuffix") employee_date_of_birth: Optional[date] = Field(default=None, description="Employee's date of birth", alias="employeeDateOfBirth") - origin_of_health_coverage_code: Optional[StrictStr] = Field(description="Origin of health coverage code Available values: - A: Small Business Health Options Program (SHOP) - B: Employer-sponsored coverage - C: Government-sponsored program - D: Individual market insurance - E: Multiemployer plan - F: Other designated minimum essential coverage - G: Employer-sponsored coverage that is an individual coverage HRA (valid for tax years 2020 and later)", alias="originOfHealthCoverageCode") + origin_of_health_coverage_code: Optional[StrictStr] = Field(description="Origin of health coverage code. Available values: - A: Small Business Health Options Program (SHOP) - B: Employer-sponsored coverage - C: Government-sponsored program - D: Individual market insurance - E: Multiemployer plan - F: Other designated minimum essential coverage - G: Employer-sponsored coverage that is an individual coverage HRA (valid for tax years 2020 and later)", alias="originOfHealthCoverageCode") covered_individuals: Optional[List[CoveredIndividual]] = Field(default=None, description="Covered individuals information - At least one month of coverage must be entered if it's not a correction.", alias="coveredIndividuals") - type: StrictStr = Field(description="Form type") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -76,21 +76,21 @@ class Form1095B(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -109,8 +109,8 @@ def origin_of_health_coverage_code_validate_enum(cls, value): @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -119,8 +119,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -354,6 +354,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1095_c.py b/Avalara/SDK/models/A1099/V2/form1095_c.py index ec8058f..e7e030d 100644 --- a/Avalara/SDK/models/A1099/V2/form1095_c.py +++ b/Avalara/SDK/models/A1099/V2/form1095_c.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -58,16 +58,16 @@ class Form1095C(BaseModel): employer_provided_si_coverage: Optional[StrictBool] = Field(default=None, description="Employer provided self-insured coverage", alias="employerProvidedSiCoverage") offer_and_coverages: List[OfferAndCoverage] = Field(description="Offer and coverage information", alias="offerAndCoverages") covered_individuals: Optional[List[CoveredIndividual]] = Field(default=None, description="Covered individuals information", alias="coveredIndividuals") - type: StrictStr = Field(description="Form type") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -79,21 +79,21 @@ class Form1095C(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -112,8 +112,8 @@ def plan_start_month_validate_enum(cls, value): @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -122,8 +122,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -357,6 +357,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1099_base.py b/Avalara/SDK/models/A1099/V2/form1099_base.py index d23efa7..21e3617 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_base.py +++ b/Avalara/SDK/models/A1099/V2/form1099_base.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -47,16 +47,16 @@ class Form1099Base(BaseModel): """ Form1099Base """ # noqa: E501 - type: StrictStr = Field(description="Form type") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -68,21 +68,21 @@ class Form1099Base(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -91,8 +91,8 @@ class Form1099Base(BaseModel): @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -101,8 +101,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -336,6 +336,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1099_div.py b/Avalara/SDK/models/A1099/V2/form1099_div.py index a1970f0..7e0aa4e 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_div.py +++ b/Avalara/SDK/models/A1099/V2/form1099_div.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -45,7 +45,7 @@ class Form1099Div(BaseModel): """ - Form 1099-DIV: Dividends and Distributions + Form 1099-DIV: Dividends and Distributions *At least one of the following dividend or distribution amounts must be provided:* Total ordinary dividends, Total capital gain distributions, Nondividend distributions, Cash liquidation distributions, Noncash liquidation distributions, or Exempt-interest dividends. """ # noqa: E501 total_ordinary_dividends: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Total ordinary dividends", alias="totalOrdinaryDividends") qualified_dividends: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Qualified dividends", alias="qualifiedDividends") @@ -65,17 +65,17 @@ class Form1099Div(BaseModel): noncash_liquidation_distributions: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Noncash liquidation distributions", alias="noncashLiquidationDistributions") exempt_interest_dividends: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Exempt-interest dividends", alias="exemptInterestDividends") specified_private_activity_bond_interest_dividends: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Specified private activity bond interest dividends", alias="specifiedPrivateActivityBondInterestDividends") - fatca_filing_requirement: Optional[StrictBool] = Field(default=None, description="FATCA filing requirement", alias="fatcaFilingRequirement") - type: StrictStr = Field(description="Form type") + fatca_filing_requirement: Optional[StrictBool] = Field(default=None, description="FATCA filing requirement.", alias="fatcaFilingRequirement") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -87,21 +87,21 @@ class Form1099Div(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -110,8 +110,8 @@ class Form1099Div(BaseModel): @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -120,8 +120,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -355,6 +355,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1099_int.py b/Avalara/SDK/models/A1099/V2/form1099_int.py index a08956e..96bf88b 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_int.py +++ b/Avalara/SDK/models/A1099/V2/form1099_int.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -45,7 +45,7 @@ class Form1099Int(BaseModel): """ - Form1099Int + Form 1099-INT: Interest Imcome *At least one of the following amounts must be provided:* Interest Income, Interest on U.S. Savings Bonds and Treasury obligations, or Tax-Exempt Interest. """ # noqa: E501 interest_income: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Interest Income", alias="interestIncome") early_withdrawal_penalty: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Early Withdrawal Penalty", alias="earlyWithdrawalPenalty") @@ -60,18 +60,18 @@ class Form1099Int(BaseModel): bond_premium: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Bond Premium", alias="bondPremium") bond_premium_on_treasury_obligations: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Bond Premium on Treasury obligations", alias="bondPremiumOnTreasuryObligations") bond_premium_on_tax_exempt_bond: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Bond Premium on tax exempt bond", alias="bondPremiumOnTaxExemptBond") - tax_exempt_bond_cusip_number: Optional[StrictStr] = Field(default=None, description="Tax exempt bond CUSIP no.", alias="taxExemptBondCusipNumber") - fatca_filing_requirement: Optional[StrictBool] = Field(default=None, description="FATCA filing requirement", alias="fatcaFilingRequirement") - type: StrictStr = Field(description="Form type") + tax_exempt_bond_cusip_number: Optional[StrictStr] = Field(default=None, description="Tax exempt bond CUSIP no. Enter VARIOUS if the tax-exempt interest is reported in the aggregate for multiple bonds or accounts.", alias="taxExemptBondCusipNumber") + fatca_filing_requirement: Optional[StrictBool] = Field(default=None, description="FATCA filing requirement.", alias="fatcaFilingRequirement") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -83,21 +83,21 @@ class Form1099Int(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -106,8 +106,8 @@ class Form1099Int(BaseModel): @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -116,8 +116,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -351,6 +351,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1099_k.py b/Avalara/SDK/models/A1099/V2/form1099_k.py index d278efd..d3477ae 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_k.py +++ b/Avalara/SDK/models/A1099/V2/form1099_k.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -47,13 +47,13 @@ class Form1099K(BaseModel): """ Form 1099-K: Payment Card and Third Party Network Transactions """ # noqa: E501 - filer_type: Optional[StrictStr] = Field(default=None, description="Filer type (PSE or EPF)", alias="filerType") - payment_type: Optional[StrictStr] = Field(default=None, description="Payment type (payment card or third party network)", alias="paymentType") - payment_settlement_entity_name_phone_number: Optional[StrictStr] = Field(default=None, description="Payment settlement entity name and phone number", alias="paymentSettlementEntityNamePhoneNumber") - gross_amount_payment_card: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Gross amount of payment card/third party network transactions", alias="grossAmountPaymentCard") + filer_type: Optional[StrictStr] = Field(description="Filer type for tax reporting purposes. Available values: - PSE: Payment Settlement Entity - EPF: Electronic Payment Facilitator or other third party", alias="filerType") + payment_type: Optional[StrictStr] = Field(description="Payment type for transaction classification. Available values: - PaymentCard: Payment card transactions - ThirdPartyNetwork: Third party network transactions", alias="paymentType") + payment_settlement_entity_name_phone_number: Optional[StrictStr] = Field(default=None, description="Payment settlement entity name and phone number, if different from Filer's", alias="paymentSettlementEntityNamePhoneNumber") + gross_amount_payment_card: Optional[Union[StrictFloat, StrictInt]] = Field(description="Gross amount of payment card/third party network transactions. This value must equal the total of all monthly payment amounts (January through December).", alias="grossAmountPaymentCard") card_not_present_transactions: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Card not present transactions", alias="cardNotPresentTransactions") - merchant_category_code: Optional[StrictStr] = Field(default=None, description="Merchant category code", alias="merchantCategoryCode") - payment_transaction_number: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Number of payment transactions", alias="paymentTransactionNumber") + merchant_category_code: Optional[StrictStr] = Field(default=None, description="Merchant category code (4 numbers)", alias="merchantCategoryCode") + payment_transaction_number: Optional[Union[StrictFloat, StrictInt]] = Field(description="Number of payment transactions", alias="paymentTransactionNumber") federal_income_tax_withheld: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Federal income tax withheld", alias="federalIncomeTaxWithheld") january: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="January gross payments") february: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="February gross payments") @@ -67,16 +67,16 @@ class Form1099K(BaseModel): october: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="October gross payments") november: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="November gross payments") december: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="December gross payments") - type: StrictStr = Field(description="Form type") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -88,21 +88,21 @@ class Form1099K(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -114,8 +114,8 @@ def filer_type_validate_enum(cls, value): if value is None: return value - if value not in set(['PSE', 'EPF', 'Other']): - raise ValueError("must be one of enum values ('PSE', 'EPF', 'Other')") + if value not in set(['PSE', 'EPF']): + raise ValueError("must be one of enum values ('PSE', 'EPF')") return value @field_validator('payment_type') @@ -124,15 +124,15 @@ def payment_type_validate_enum(cls, value): if value is None: return value - if value not in set(['MerchantPaymentCard', 'ThirdPartyNetwork']): - raise ValueError("must be one of enum values ('MerchantPaymentCard', 'ThirdPartyNetwork')") + if value not in set(['PaymentCard', 'ThirdPartyNetwork']): + raise ValueError("must be one of enum values ('PaymentCard', 'ThirdPartyNetwork')") return value @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -141,8 +141,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -376,6 +376,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1099_list_request.py b/Avalara/SDK/models/A1099/V2/form1099_list_request.py index cde7732..8cbca24 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_list_request.py +++ b/Avalara/SDK/models/A1099/V2/form1099_list_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -53,8 +53,8 @@ def type_validate_enum(cls, value): if value is None: return value - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value model_config = ConfigDict( diff --git a/Avalara/SDK/models/A1099/V2/form1099_misc.py b/Avalara/SDK/models/A1099/V2/form1099_misc.py index 20e880b..0cf27a3 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_misc.py +++ b/Avalara/SDK/models/A1099/V2/form1099_misc.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -45,7 +45,7 @@ class Form1099Misc(BaseModel): """ - Form 1099-MISC: Miscellaneous Income + Form 1099-MISC: Miscellaneous Income *At least one of the following amounts must be provided:* Rents, Royalties, Other income, Fishing boat proceeds, Medical and health care payments, Substitute payments in lieu of dividends or interest, Crop insurance proceeds, Gross proceeds paid to an attorney, Fish purchased for resale, Section 409A deferrals, Excess golden parachute payments, Nonqualified deferred compensation, Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale """ # noqa: E501 rents: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Rents") royalties: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Royalties") @@ -61,17 +61,17 @@ class Form1099Misc(BaseModel): section409_a_deferrals: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Section 409A deferrals", alias="section409ADeferrals") excess_golden_parachute_payments: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="(Legacy field) Excess golden parachute payments", alias="excessGoldenParachutePayments") nonqualified_deferred_compensation: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Nonqualified deferred compensation", alias="nonqualifiedDeferredCompensation") - fatca_filing_requirement: Optional[StrictBool] = Field(default=None, description="FATCA filing requirement", alias="fatcaFilingRequirement") - type: StrictStr = Field(description="Form type") + fatca_filing_requirement: Optional[StrictBool] = Field(default=None, description="FATCA filing requirement.", alias="fatcaFilingRequirement") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -83,21 +83,21 @@ class Form1099Misc(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -106,8 +106,8 @@ class Form1099Misc(BaseModel): @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -116,8 +116,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -351,6 +351,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1099_nec.py b/Avalara/SDK/models/A1099/V2/form1099_nec.py index 94b3b52..544b620 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_nec.py +++ b/Avalara/SDK/models/A1099/V2/form1099_nec.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -45,21 +45,21 @@ class Form1099Nec(BaseModel): """ - Form1099Nec + Form 1099-NEC: Nonemployee Compensation """ # noqa: E501 - nonemployee_compensation: Optional[Union[StrictFloat, StrictInt]] = Field(description="Nonemployee compensation", alias="nonemployeeCompensation") - direct_sales_indicator: Optional[StrictBool] = Field(default=None, description="Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale", alias="directSalesIndicator") - federal_income_tax_withheld: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Federal income tax withheld", alias="federalIncomeTaxWithheld") - type: StrictStr = Field(description="Form type") + nonemployee_compensation: Optional[Union[StrictFloat, StrictInt]] = Field(description="Nonemployee compensation. Required if DirectSalesIndicator is false.", alias="nonemployeeCompensation") + direct_sales_indicator: Optional[StrictBool] = Field(default=None, description="Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale. Should be true if Nonemployee compensation is not provided.", alias="directSalesIndicator") + federal_income_tax_withheld: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Federal income tax withheld.", alias="federalIncomeTaxWithheld") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -71,21 +71,21 @@ class Form1099Nec(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") @@ -94,8 +94,8 @@ class Form1099Nec(BaseModel): @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -104,8 +104,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -339,6 +339,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1099_r.py b/Avalara/SDK/models/A1099/V2/form1099_r.py index 47e5923..2583a0f 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_r.py +++ b/Avalara/SDK/models/A1099/V2/form1099_r.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -45,7 +45,7 @@ class Form1099R(BaseModel): """ - Form 1099-R: Distributions From Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc. + Form 1099-R: Distributions From Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc. *At least one of the following amounts must be provided:* Gross distribution, Taxable amount, Capital gain, Employee contributions/Designated Roth contributions or insurance premiums, Net unrealized appreciation in employer's securities, Other amount, Total employee contributions, Traditional IRA/SEP/SIMPLE or Roth conversion amount, or Amount allocable to IRR within 5 years """ # noqa: E501 gross_distribution: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Gross distribution", alias="grossDistribution") taxable_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Taxable amount", alias="taxableAmount") @@ -55,8 +55,8 @@ class Form1099R(BaseModel): federal_income_tax_withheld: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Federal income tax withheld", alias="federalIncomeTaxWithheld") employee_contributions_or_designated_roth_or_insurance_premiums: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Employee contributions/Designated Roth contributions or insurance premiums", alias="employeeContributionsOrDesignatedRothOrInsurancePremiums") net_unrealized_appreciation_in_employer_securities: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Net unrealized appreciation in employer's securities", alias="netUnrealizedAppreciationInEmployerSecurities") - distribution_code: Optional[StrictStr] = Field(default=None, description="Distribution code", alias="distributionCode") - second_distribution_code: Optional[StrictStr] = Field(default=None, description="Second distribution code", alias="secondDistributionCode") + distribution_code: Optional[StrictStr] = Field(description="Distribution code. Available values: - 1: Early distribution, no known exception (in most cases, under age 59½) - 2: Early distribution, exception applies (under age 59½) - 3: Disability - 4: Death - 5: Prohibited transaction - 6: Section 1035 exchange (a tax-free exchange of life insurance, annuity, qualified long-term care insurance, or endowment contracts) - 7: Normal distribution - 8: Excess contributions plus earnings/excess deferrals (and/or earnings) taxable in payment year - 9: Cost of current life insurance protection (premiums paid by a trustee or custodian for current insurance protection) - A: May be eligible for 10-year tax option - B: Designated Roth account distribution - C: Reportable Death Benefits Under Section 6050Y(c) - D: Annuity payments from nonqualified annuity payments and distributions from life insurance contracts that may be subject to tax under section 1411 - E: Distribution under Employee Plans Compliance Resolution System (EPCRS) - F: Charitable gift annuity - G: Direct rollover and rollover contribution - H: Direct rollover of distribution from a designated Roth account to a Roth IRA - J: Early distribution from a Roth IRA (This code may be used with a Code 8 or P) - K: Distribution of IRA Assets Not Having A Readily Available FMV - L: Loans treated as deemed distributions under section 72(p) - M: Qualified Plan Loan Offsets - N: Recharacterized IRA contribution made for year following payment year - P: Excess contributions plus earnings/excess deferrals taxable for year prior to payment year - Q: Qualified distribution from a Roth IRA (Distribution from a Roth IRA when the 5-year holding period has been met, and the recipient has reached 59½, has died, or is disabled) - R: Recharacterized IRA contribution made for year prior to payment year - S: Early distribution from a SIMPLE IRA in first 2 years no known exceptions - T: Roth IRA distribution exception applies because participant has reached 59½, died or is disabled, but it is unknown if the 5-year period has been met - U: Distribution from ESOP under Section 404(k) - W: Charges or payments for purchasing qualified long-term care insurance contracts under combined arrangements", alias="distributionCode") + second_distribution_code: Optional[StrictStr] = Field(default=None, description="Second distribution code. Must be a valid combination with the first distribution code. See DistributionCode property documentation for code descriptions. Valid combinations based on first distribution code: - 1: _, 8, B, D, K, L, M, P - 2: _, 8, B, D, K, L, M, P - 3: _, D - 4: _, 8, A, B, D, G, H, K, L, M, P - 5: _ - 6: _, W - 7: _, A, B, D, K, L, M - 8: _, 1, 2, 4, B, J, K - 9: _ - A: 4, 7 - B: _, 1, 2, 4, 7, 8, G, L, M, P, U - C: _, D - D: 1, 2, 3, 4, 7, C - E: _ - F: _ - G: _, 4, B, K - H: _, 4 - J: _, 8, P - K: 1, 2, 4, 7, 8, G - L: _, 1, 2, 4, 7, B - M: _, 1, 2, 4, 7, B - N: _ - P: _, 1, 2, 4, B, J - Q: _ - R: _ - S: _ - T: _ - U: _, B - W: _, 6 (_ indicates no second distribution code) (format: firstDistributionCode: availableSecondDistributionCodes)", alias="secondDistributionCode") ira_sep_simple: Optional[StrictBool] = Field(default=None, description="IRA/SEP/SIMPLE", alias="iraSepSimple") traditional_ira_sep_simple_or_roth_conversion_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Traditional IRA/SEP/SIMPLE or Roth conversion amount", alias="traditionalIraSepSimpleOrRothConversionAmount") other_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Other amount", alias="otherAmount") @@ -66,17 +66,17 @@ class Form1099R(BaseModel): amount_allocable_to_irr_within5_years: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Amount allocable to IRR within 5 years", alias="amountAllocableToIrrWithin5Years") first_year_of_designated_roth_contribution: Optional[StrictStr] = Field(default=None, description="First year of designated Roth contribution", alias="firstYearOfDesignatedRothContribution") date_of_payment: Optional[date] = Field(default=None, description="Date of payment", alias="dateOfPayment") - fatca_filing_requirement: Optional[StrictBool] = Field(default=None, description="FATCA filing requirement", alias="fatcaFilingRequirement") - type: StrictStr = Field(description="Form type") + fatca_filing_requirement: Optional[StrictBool] = Field(default=None, description="FATCA filing requirement.", alias="fatcaFilingRequirement") + type: StrictStr = Field(description="Form type.") id: Optional[StrictStr] = Field(default=None, description="Form ID. Unique identifier set when the record is created.") issuer_id: Optional[StrictStr] = Field(default=None, description="Issuer ID - only required when creating forms", alias="issuerId") - issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms", alias="issuerReferenceId") + issuer_reference_id: Optional[StrictStr] = Field(default=None, description="Issuer Reference ID - only required when creating forms via $bulk-upsert", alias="issuerReferenceId") issuer_tin: Optional[StrictStr] = Field(default=None, description="Issuer TIN - readonly", alias="issuerTin") - tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms", alias="taxYear") + tax_year: Optional[StrictInt] = Field(default=None, description="Tax Year - only required when creating forms via $bulk-upsert", alias="taxYear") reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient.", alias="referenceId") tin: Optional[StrictStr] = Field(default=None, description="Recipient's Federal Tax Identification Number (TIN).") recipient_name: Optional[StrictStr] = Field(description="Recipient name", alias="recipientName") - tin_type: Optional[StrictStr] = Field(default=None, description="Type of TIN (Tax ID Number)", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number", alias="tinType") recipient_second_name: Optional[StrictStr] = Field(default=None, description="Recipient second name", alias="recipientSecondName") address: Optional[StrictStr] = Field(description="Address.") address2: Optional[StrictStr] = Field(default=None, description="Address line 2.") @@ -88,31 +88,51 @@ class Form1099R(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="Office code", alias="officeCode") non_us_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="nonUsProvince") country_code: Optional[StrictStr] = Field(description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.", alias="countryCode") - federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled for this form", alias="federalEfileDate") + federal_efile_date: Optional[date] = Field(default=None, description="Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="federalEfileDate") postal_mail: Optional[StrictBool] = Field(default=None, description="Boolean indicating that postal mailing to the recipient should be scheduled for this form", alias="postalMail") - state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled for this form", alias="stateEfileDate") - recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled for this form", alias="recipientEdeliveryDate") + state_efile_date: Optional[date] = Field(default=None, description="Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="stateEfileDate") + recipient_edelivery_date: Optional[date] = Field(default=None, description="Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.", alias="recipientEdeliveryDate") tin_match: Optional[StrictBool] = Field(default=None, description="Boolean indicating that TIN Matching should be scheduled for this form", alias="tinMatch") no_tin: Optional[StrictBool] = Field(default=None, description="No TIN indicator", alias="noTin") address_verification: Optional[StrictBool] = Field(default=None, description="Boolean indicating that address verification should be scheduled for this form", alias="addressVerification") state_and_local_withholding: Optional[StateAndLocalWithholding] = Field(default=None, description="State and local withholding information", alias="stateAndLocalWithholding") second_tin_notice: Optional[StrictBool] = Field(default=None, description="Second TIN notice", alias="secondTinNotice") - federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status", alias="federalEfileStatus") - state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status", alias="stateEfileStatus") - postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status", alias="postalMailStatus") - tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status", alias="tinMatchStatus") - address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status", alias="addressVerificationStatus") - e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status", alias="eDeliveryStatus") + federal_efile_status: Optional[Form1099StatusDetail] = Field(default=None, description="Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)", alias="federalEfileStatus") + state_efile_status: Optional[List[StateEfileStatusDetail]] = Field(default=None, description="State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state", alias="stateEfileStatus") + postal_mail_status: Optional[Form1099StatusDetail] = Field(default=None, description="Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered", alias="postalMailStatus") + tin_match_status: Optional[Form1099StatusDetail] = Field(default=None, description="TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued", alias="tinMatchStatus") + address_verification_status: Optional[Form1099StatusDetail] = Field(default=None, description="Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted", alias="addressVerificationStatus") + e_delivery_status: Optional[Form1099StatusDetail] = Field(default=None, description="EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)", alias="eDeliveryStatus") validation_errors: Optional[List[ValidationError]] = Field(default=None, description="Validation errors", alias="validationErrors") created_at: Optional[datetime] = Field(default=None, description="Date time when the record was created.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="Date time when the record was last updated.", alias="updatedAt") __properties: ClassVar[List[str]] = ["type", "id", "issuerId", "issuerReferenceId", "issuerTin", "taxYear", "referenceId", "tin", "recipientName", "tinType", "recipientSecondName", "address", "address2", "city", "state", "zip", "email", "accountNumber", "officeCode", "nonUsProvince", "countryCode", "federalEfileDate", "postalMail", "stateEfileDate", "recipientEdeliveryDate", "tinMatch", "noTin", "addressVerification", "stateAndLocalWithholding", "secondTinNotice", "federalEfileStatus", "stateEfileStatus", "postalMailStatus", "tinMatchStatus", "addressVerificationStatus", "eDeliveryStatus", "validationErrors", "createdAt", "updatedAt"] + @field_validator('distribution_code') + def distribution_code_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R', 'S', 'T', 'U', 'W']): + raise ValueError("must be one of enum values ('1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R', 'S', 'T', 'U', 'W')") + return value + + @field_validator('second_distribution_code') + def second_distribution_code_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R', 'S', 'T', 'U', 'W']): + raise ValueError("must be one of enum values ('1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R', 'S', 'T', 'U', 'W')") + return value + @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT']): - raise ValueError("must be one of enum values ('1099-NEC', '1099-MISC', '1099-DIV', '1099-R', '1099-K', '1095-B', '1042-S', '1095-C', '1099-INT')") + if value not in set(['Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int']): + raise ValueError("must be one of enum values ('Form1099Nec', 'Form1099Misc', 'Form1099Div', 'Form1099R', 'Form1099K', 'Form1095B', 'Form1042S', 'Form1095C', 'Form1099Int')") return value @field_validator('tin_type') @@ -121,8 +141,8 @@ def tin_type_validate_enum(cls, value): if value is None: return value - if value not in set(['Empty', 'EIN', 'SSN', 'ITIN', 'ATIN']): - raise ValueError("must be one of enum values ('Empty', 'EIN', 'SSN', 'ITIN', 'ATIN')") + if value not in set(['EIN', 'SSN', 'ITIN', 'ATIN']): + raise ValueError("must be one of enum values ('EIN', 'SSN', 'ITIN', 'ATIN')") return value model_config = ConfigDict( @@ -356,6 +376,11 @@ def to_dict(self) -> Dict[str, Any]: if self.state_and_local_withholding is None and "state_and_local_withholding" in self.model_fields_set: _dict['stateAndLocalWithholding'] = None + # set to None if second_tin_notice (nullable) is None + # and model_fields_set contains the field + if self.second_tin_notice is None and "second_tin_notice" in self.model_fields_set: + _dict['secondTinNotice'] = None + # set to None if federal_efile_status (nullable) is None # and model_fields_set contains the field if self.federal_efile_status is None and "federal_efile_status" in self.model_fields_set: diff --git a/Avalara/SDK/models/A1099/V2/form1099_status_detail.py b/Avalara/SDK/models/A1099/V2/form1099_status_detail.py index 01b558d..d0664a7 100644 --- a/Avalara/SDK/models/A1099/V2/form1099_status_detail.py +++ b/Avalara/SDK/models/A1099/V2/form1099_status_detail.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/get1099_form200_response.py b/Avalara/SDK/models/A1099/V2/get1099_form200_response.py index a9a7e2c..3028c83 100644 --- a/Avalara/SDK/models/A1099/V2/get1099_form200_response.py +++ b/Avalara/SDK/models/A1099/V2/get1099_form200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/intermediary_or_flow_through.py b/Avalara/SDK/models/A1099/V2/intermediary_or_flow_through.py index 6efd99a..71f29e9 100644 --- a/Avalara/SDK/models/A1099/V2/intermediary_or_flow_through.py +++ b/Avalara/SDK/models/A1099/V2/intermediary_or_flow_through.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -33,7 +33,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self @@ -43,8 +43,8 @@ class IntermediaryOrFlowThrough(BaseModel): Intermediary or flow-through entity information for tax forms """ # noqa: E501 ein: Optional[StrictStr] = Field(default=None, description="EIN (Employer Identification Number) of the intermediary or flow-through entity") - chap3_status_code: Optional[StrictStr] = Field(default=None, description="Chapter 3 status code for the intermediary or flow-through entity", alias="chap3StatusCode") - chap4_status_code: Optional[StrictStr] = Field(default=None, description="Chapter 4 status code for the intermediary or flow-through entity", alias="chap4StatusCode") + chap3_status_code: Optional[StrictStr] = Field(default=None, description="Chapter 3 status code for the intermediary or flow-through entity. Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary", alias="chap3StatusCode") + chap4_status_code: Optional[StrictStr] = Field(default=None, description="Chapter 4 status code for the intermediary or flow-through entity. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI", alias="chap4StatusCode") name: Optional[StrictStr] = Field(default=None, description="Name of the intermediary or flow-through entity") giin: Optional[StrictStr] = Field(default=None, description="GIIN (Global Intermediary Identification Number) of the intermediary or flow-through entity") country_code: Optional[StrictStr] = Field(default=None, description="Country code for the intermediary or flow-through entity", alias="countryCode") @@ -55,6 +55,26 @@ class IntermediaryOrFlowThrough(BaseModel): zip: Optional[StrictStr] = Field(default=None, description="Zip code of the intermediary or flow-through entity") __properties: ClassVar[List[str]] = ["ein", "chap3StatusCode", "chap4StatusCode", "name", "giin", "countryCode", "foreignTin", "address", "city", "state", "zip"] + @field_validator('chap3_status_code') + def chap3_status_code_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['01', '02', '34', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '35', '36', '37', '38', '39']): + raise ValueError("must be one of enum values ('01', '02', '34', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '35', '36', '37', '38', '39')") + return value + + @field_validator('chap4_status_code') + def chap4_status_code_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50']): + raise ValueError("must be one of enum values ('01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50')") + return value + model_config = ConfigDict( populate_by_name=True, validate_assignment=True, diff --git a/Avalara/SDK/models/A1099/V2/irs_response.py b/Avalara/SDK/models/A1099/V2/irs_response.py index c75272f..528ca64 100644 --- a/Avalara/SDK/models/A1099/V2/irs_response.py +++ b/Avalara/SDK/models/A1099/V2/irs_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/issuer_base.py b/Avalara/SDK/models/A1099/V2/issuer_base.py new file mode 100644 index 0000000..5eae413 --- /dev/null +++ b/Avalara/SDK/models/A1099/V2/issuer_base.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara 1099 & W-9 API Definition + ## 🔐 Authentication Generate a **license key** from: *[Avalara Portal](https://www.avalara.com/us/en/signin.html) → Settings → License and API Keys*. [More on authentication methods](https://developer.avalara.com/avatax-dm-combined-erp/common-setup/authentication/authentication-methods/) [Test your credentials](https://developer.avalara.com/avatax/test-credentials/) ## 📘 API & SDK Documentation [Avalara SDK (.NET) on GitHub](https://github.com/avadev/Avalara-SDK-DotNet#avalarasdk--the-unified-c-library-for-next-gen-avalara-services) [Code Examples – 1099 API](https://github.com/avadev/Avalara-SDK-DotNet/blob/main/docs/A1099/V2/Class1099IssuersApi.md#call1099issuersget) + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 25.9.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class IssuerBase(BaseModel): + """ + IssuerBase + """ # noqa: E501 + name: Optional[StrictStr] = Field(description="Legal name. Not the DBA name.") + dba_name: Optional[StrictStr] = Field(default=None, description="Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'.", alias="dbaName") + tin: Optional[StrictStr] = Field(default=None, description="Federal Tax Identification Number (TIN).") + reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces.", alias="referenceId") + telephone: Optional[StrictStr] = Field(description="Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries.") + tax_year: Optional[StrictInt] = Field(description="Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4.", alias="taxYear") + country_code: Optional[StrictStr] = Field(default=None, description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address.", alias="countryCode") + email: Optional[StrictStr] = Field(description="Contact email address. For recipient inquiries.") + address: Optional[StrictStr] = Field(description="Address.") + city: Optional[StrictStr] = Field(description="City.") + state: Optional[StrictStr] = Field(description="Two-letter US state or Canadian province code (required for US/CA addresses).") + zip: Optional[StrictStr] = Field(description="ZIP/postal code.") + foreign_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="foreignProvince") + transfer_agent_name: Optional[StrictStr] = Field(default=None, description="Name of the transfer agent, if applicable — optional; use either this or 'dbaName'.", alias="transferAgentName") + last_filing: Optional[StrictBool] = Field(description="Indicates if this is the issuer's final year filing.", alias="lastFiling") + __properties: ClassVar[List[str]] = ["name", "dbaName", "tin", "referenceId", "telephone", "taxYear", "countryCode", "email", "address", "city", "state", "zip", "foreignProvince", "transferAgentName", "lastFiling"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IssuerBase from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + # set to None if dba_name (nullable) is None + # and model_fields_set contains the field + if self.dba_name is None and "dba_name" in self.model_fields_set: + _dict['dbaName'] = None + + # set to None if tin (nullable) is None + # and model_fields_set contains the field + if self.tin is None and "tin" in self.model_fields_set: + _dict['tin'] = None + + # set to None if reference_id (nullable) is None + # and model_fields_set contains the field + if self.reference_id is None and "reference_id" in self.model_fields_set: + _dict['referenceId'] = None + + # set to None if telephone (nullable) is None + # and model_fields_set contains the field + if self.telephone is None and "telephone" in self.model_fields_set: + _dict['telephone'] = None + + # set to None if tax_year (nullable) is None + # and model_fields_set contains the field + if self.tax_year is None and "tax_year" in self.model_fields_set: + _dict['taxYear'] = None + + # set to None if country_code (nullable) is None + # and model_fields_set contains the field + if self.country_code is None and "country_code" in self.model_fields_set: + _dict['countryCode'] = None + + # set to None if email (nullable) is None + # and model_fields_set contains the field + if self.email is None and "email" in self.model_fields_set: + _dict['email'] = None + + # set to None if address (nullable) is None + # and model_fields_set contains the field + if self.address is None and "address" in self.model_fields_set: + _dict['address'] = None + + # set to None if city (nullable) is None + # and model_fields_set contains the field + if self.city is None and "city" in self.model_fields_set: + _dict['city'] = None + + # set to None if state (nullable) is None + # and model_fields_set contains the field + if self.state is None and "state" in self.model_fields_set: + _dict['state'] = None + + # set to None if zip (nullable) is None + # and model_fields_set contains the field + if self.zip is None and "zip" in self.model_fields_set: + _dict['zip'] = None + + # set to None if foreign_province (nullable) is None + # and model_fields_set contains the field + if self.foreign_province is None and "foreign_province" in self.model_fields_set: + _dict['foreignProvince'] = None + + # set to None if transfer_agent_name (nullable) is None + # and model_fields_set contains the field + if self.transfer_agent_name is None and "transfer_agent_name" in self.model_fields_set: + _dict['transferAgentName'] = None + + # set to None if last_filing (nullable) is None + # and model_fields_set contains the field + if self.last_filing is None and "last_filing" in self.model_fields_set: + _dict['lastFiling'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IssuerBase from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "dbaName": obj.get("dbaName"), + "tin": obj.get("tin"), + "referenceId": obj.get("referenceId"), + "telephone": obj.get("telephone"), + "taxYear": obj.get("taxYear"), + "countryCode": obj.get("countryCode"), + "email": obj.get("email"), + "address": obj.get("address"), + "city": obj.get("city"), + "state": obj.get("state"), + "zip": obj.get("zip"), + "foreignProvince": obj.get("foreignProvince"), + "transferAgentName": obj.get("transferAgentName"), + "lastFiling": obj.get("lastFiling") + }) + return _obj + + diff --git a/Avalara/SDK/models/A1099/V2/issuer_request.py b/Avalara/SDK/models/A1099/V2/issuer_request.py new file mode 100644 index 0000000..629a3ea --- /dev/null +++ b/Avalara/SDK/models/A1099/V2/issuer_request.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara 1099 & W-9 API Definition + ## 🔐 Authentication Generate a **license key** from: *[Avalara Portal](https://www.avalara.com/us/en/signin.html) → Settings → License and API Keys*. [More on authentication methods](https://developer.avalara.com/avatax-dm-combined-erp/common-setup/authentication/authentication-methods/) [Test your credentials](https://developer.avalara.com/avatax/test-credentials/) ## 📘 API & SDK Documentation [Avalara SDK (.NET) on GitHub](https://github.com/avadev/Avalara-SDK-DotNet#avalarasdk--the-unified-c-library-for-next-gen-avalara-services) [Code Examples – 1099 API](https://github.com/avadev/Avalara-SDK-DotNet/blob/main/docs/A1099/V2/Class1099IssuersApi.md#call1099issuersget) + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 25.9.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class IssuerRequest(BaseModel): + """ + IssuerRequest + """ # noqa: E501 + name: Optional[StrictStr] = Field(description="Legal name. Not the DBA name.") + dba_name: Optional[StrictStr] = Field(default=None, description="Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'.", alias="dbaName") + tin: Optional[StrictStr] = Field(default=None, description="Federal Tax Identification Number (TIN).") + reference_id: Optional[StrictStr] = Field(default=None, description="Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces.", alias="referenceId") + telephone: Optional[StrictStr] = Field(description="Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries.") + tax_year: Optional[StrictInt] = Field(description="Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4.", alias="taxYear") + country_code: Optional[StrictStr] = Field(default=None, description="Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address.", alias="countryCode") + email: Optional[StrictStr] = Field(description="Contact email address. For recipient inquiries.") + address: Optional[StrictStr] = Field(description="Address.") + city: Optional[StrictStr] = Field(description="City.") + state: Optional[StrictStr] = Field(description="Two-letter US state or Canadian province code (required for US/CA addresses).") + zip: Optional[StrictStr] = Field(description="ZIP/postal code.") + foreign_province: Optional[StrictStr] = Field(default=None, description="Province or region for non-US/CA addresses.", alias="foreignProvince") + transfer_agent_name: Optional[StrictStr] = Field(default=None, description="Name of the transfer agent, if applicable — optional; use either this or 'dbaName'.", alias="transferAgentName") + last_filing: Optional[StrictBool] = Field(description="Indicates if this is the issuer's final year filing.", alias="lastFiling") + __properties: ClassVar[List[str]] = ["name", "dbaName", "tin", "referenceId", "telephone", "taxYear", "countryCode", "email", "address", "city", "state", "zip", "foreignProvince", "transferAgentName", "lastFiling"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IssuerRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + # set to None if dba_name (nullable) is None + # and model_fields_set contains the field + if self.dba_name is None and "dba_name" in self.model_fields_set: + _dict['dbaName'] = None + + # set to None if tin (nullable) is None + # and model_fields_set contains the field + if self.tin is None and "tin" in self.model_fields_set: + _dict['tin'] = None + + # set to None if reference_id (nullable) is None + # and model_fields_set contains the field + if self.reference_id is None and "reference_id" in self.model_fields_set: + _dict['referenceId'] = None + + # set to None if telephone (nullable) is None + # and model_fields_set contains the field + if self.telephone is None and "telephone" in self.model_fields_set: + _dict['telephone'] = None + + # set to None if tax_year (nullable) is None + # and model_fields_set contains the field + if self.tax_year is None and "tax_year" in self.model_fields_set: + _dict['taxYear'] = None + + # set to None if country_code (nullable) is None + # and model_fields_set contains the field + if self.country_code is None and "country_code" in self.model_fields_set: + _dict['countryCode'] = None + + # set to None if email (nullable) is None + # and model_fields_set contains the field + if self.email is None and "email" in self.model_fields_set: + _dict['email'] = None + + # set to None if address (nullable) is None + # and model_fields_set contains the field + if self.address is None and "address" in self.model_fields_set: + _dict['address'] = None + + # set to None if city (nullable) is None + # and model_fields_set contains the field + if self.city is None and "city" in self.model_fields_set: + _dict['city'] = None + + # set to None if state (nullable) is None + # and model_fields_set contains the field + if self.state is None and "state" in self.model_fields_set: + _dict['state'] = None + + # set to None if zip (nullable) is None + # and model_fields_set contains the field + if self.zip is None and "zip" in self.model_fields_set: + _dict['zip'] = None + + # set to None if foreign_province (nullable) is None + # and model_fields_set contains the field + if self.foreign_province is None and "foreign_province" in self.model_fields_set: + _dict['foreignProvince'] = None + + # set to None if transfer_agent_name (nullable) is None + # and model_fields_set contains the field + if self.transfer_agent_name is None and "transfer_agent_name" in self.model_fields_set: + _dict['transferAgentName'] = None + + # set to None if last_filing (nullable) is None + # and model_fields_set contains the field + if self.last_filing is None and "last_filing" in self.model_fields_set: + _dict['lastFiling'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IssuerRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "dbaName": obj.get("dbaName"), + "tin": obj.get("tin"), + "referenceId": obj.get("referenceId"), + "telephone": obj.get("telephone"), + "taxYear": obj.get("taxYear"), + "countryCode": obj.get("countryCode"), + "email": obj.get("email"), + "address": obj.get("address"), + "city": obj.get("city"), + "state": obj.get("state"), + "zip": obj.get("zip"), + "foreignProvince": obj.get("foreignProvince"), + "transferAgentName": obj.get("transferAgentName"), + "lastFiling": obj.get("lastFiling") + }) + return _obj + + diff --git a/Avalara/SDK/models/A1099/V2/issuer_response.py b/Avalara/SDK/models/A1099/V2/issuer_response.py index 0c230ba..631a8da 100644 --- a/Avalara/SDK/models/A1099/V2/issuer_response.py +++ b/Avalara/SDK/models/A1099/V2/issuer_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/iw9_form_data_models_one_of.py b/Avalara/SDK/models/A1099/V2/iw9_form_data_models_one_of.py index a51ad6b..a598093 100644 --- a/Avalara/SDK/models/A1099/V2/iw9_form_data_models_one_of.py +++ b/Avalara/SDK/models/A1099/V2/iw9_form_data_models_one_of.py @@ -33,11 +33,11 @@ import pprint from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator from typing import Any, List, Optional -from Avalara.SDK.models.A1099.V2.w4_form_data_model import W4FormDataModel -from Avalara.SDK.models.A1099.V2.w8_ben_form_data_model import W8BenFormDataModel -from Avalara.SDK.models.A1099.V2.w8_bene_form_data_model import W8BeneFormDataModel -from Avalara.SDK.models.A1099.V2.w8_imy_form_data_model import W8ImyFormDataModel -from Avalara.SDK.models.A1099.V2.w9_form_data_model import W9FormDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w4_form_data_model import W4FormDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w8_ben_form_data_model import W8BenFormDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w8_bene_form_data_model import W8BeneFormDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w8_imy_form_data_model import W8ImyFormDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w9_form_data_model import W9FormDataModel from pydantic import StrictStr, Field from typing import Union, List, Set, Optional, Dict from typing_extensions import Literal, Self diff --git a/Avalara/SDK/models/A1099/V2/job_response.py b/Avalara/SDK/models/A1099/V2/job_response.py index f2c04c2..5361ed4 100644 --- a/Avalara/SDK/models/A1099/V2/job_response.py +++ b/Avalara/SDK/models/A1099/V2/job_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/offer_and_coverage.py b/Avalara/SDK/models/A1099/V2/offer_and_coverage.py index 7e1a39c..b66f5d0 100644 --- a/Avalara/SDK/models/A1099/V2/offer_and_coverage.py +++ b/Avalara/SDK/models/A1099/V2/offer_and_coverage.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/paginated_query_result_model_company_response.py b/Avalara/SDK/models/A1099/V2/paginated_query_result_model_company_response.py index 0ad3df1..44dce40 100644 --- a/Avalara/SDK/models/A1099/V2/paginated_query_result_model_company_response.py +++ b/Avalara/SDK/models/A1099/V2/paginated_query_result_model_company_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/paginated_query_result_model_form1099_base.py b/Avalara/SDK/models/A1099/V2/paginated_query_result_model_form1099_base.py index 4238313..42a88b0 100644 --- a/Avalara/SDK/models/A1099/V2/paginated_query_result_model_form1099_base.py +++ b/Avalara/SDK/models/A1099/V2/paginated_query_result_model_form1099_base.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/paginated_query_result_model_issuer_response.py b/Avalara/SDK/models/A1099/V2/paginated_query_result_model_issuer_response.py index ca901c2..9eee877 100644 --- a/Avalara/SDK/models/A1099/V2/paginated_query_result_model_issuer_response.py +++ b/Avalara/SDK/models/A1099/V2/paginated_query_result_model_issuer_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/paginated_query_result_model_w9_form_base_response.py b/Avalara/SDK/models/A1099/V2/paginated_query_result_model_w9_form_base_response.py index 7b0ea4e..eed68ce 100644 --- a/Avalara/SDK/models/A1099/V2/paginated_query_result_model_w9_form_base_response.py +++ b/Avalara/SDK/models/A1099/V2/paginated_query_result_model_w9_form_base_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/primary_withholding_agent.py b/Avalara/SDK/models/A1099/V2/primary_withholding_agent.py index dde593a..04d0065 100644 --- a/Avalara/SDK/models/A1099/V2/primary_withholding_agent.py +++ b/Avalara/SDK/models/A1099/V2/primary_withholding_agent.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/state_and_local_withholding.py b/Avalara/SDK/models/A1099/V2/state_and_local_withholding.py index 5041899..7a8a767 100644 --- a/Avalara/SDK/models/A1099/V2/state_and_local_withholding.py +++ b/Avalara/SDK/models/A1099/V2/state_and_local_withholding.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/state_efile_status_detail.py b/Avalara/SDK/models/A1099/V2/state_efile_status_detail.py index f16a664..0c2c8a9 100644 --- a/Avalara/SDK/models/A1099/V2/state_efile_status_detail.py +++ b/Avalara/SDK/models/A1099/V2/state_efile_status_detail.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/substantial_us_owner_request.py b/Avalara/SDK/models/A1099/V2/substantial_us_owner_request.py index 20326dd..020fd4f 100644 --- a/Avalara/SDK/models/A1099/V2/substantial_us_owner_request.py +++ b/Avalara/SDK/models/A1099/V2/substantial_us_owner_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/substantial_us_owner_response.py b/Avalara/SDK/models/A1099/V2/substantial_us_owner_response.py index 9a9c5ec..2ca4f63 100644 --- a/Avalara/SDK/models/A1099/V2/substantial_us_owner_response.py +++ b/Avalara/SDK/models/A1099/V2/substantial_us_owner_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/tin_match_status_response.py b/Avalara/SDK/models/A1099/V2/tin_match_status_response.py index d5e098c..e1ffa89 100644 --- a/Avalara/SDK/models/A1099/V2/tin_match_status_response.py +++ b/Avalara/SDK/models/A1099/V2/tin_match_status_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/validation_error.py b/Avalara/SDK/models/A1099/V2/validation_error.py index 64079ea..00e82ea 100644 --- a/Avalara/SDK/models/A1099/V2/validation_error.py +++ b/Avalara/SDK/models/A1099/V2/validation_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/A1099/V2/w4_form_data_model.py b/Avalara/SDK/models/A1099/V2/w4_form_data_model.py index a4c10bb..a5ac328 100644 --- a/Avalara/SDK/models/A1099/V2/w4_form_data_model.py +++ b/Avalara/SDK/models/A1099/V2/w4_form_data_model.py @@ -36,7 +36,7 @@ from datetime import date, datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union -from Avalara.SDK.models.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel from typing import Optional, Set from typing_extensions import Self diff --git a/Avalara/SDK/models/A1099/V2/w4_form_minimal_request.py b/Avalara/SDK/models/A1099/V2/w4_form_minimal_request.py index 4f8e970..809372d 100644 --- a/Avalara/SDK/models/A1099/V2/w4_form_minimal_request.py +++ b/Avalara/SDK/models/A1099/V2/w4_form_minimal_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -48,7 +48,7 @@ class W4FormMinimalRequest(BaseModel): employee_first_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The first name of the employee.", alias="employeeFirstName") employee_last_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The last name of the employee.", alias="employeeLastName") office_code: Optional[StrictStr] = Field(default=None, description="The office code associated with the form.", alias="officeCode") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") __properties: ClassVar[List[str]] = ["type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w4_form_request.py b/Avalara/SDK/models/A1099/V2/w4_form_request.py index 1cd2704..7f12fe3 100644 --- a/Avalara/SDK/models/A1099/V2/w4_form_request.py +++ b/Avalara/SDK/models/A1099/V2/w4_form_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -36,7 +36,6 @@ from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union -from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -45,17 +44,17 @@ class W4FormRequest(BaseModel): W4FormRequest """ # noqa: E501 type: Optional[StrictStr] = Field(default=None, description="The form type (always \"w4\" for this model).") - employee_first_name: Optional[StrictStr] = Field(default=None, description="The first name of the employee.", alias="employeeFirstName") + employee_first_name: StrictStr = Field(description="The first name of the employee.", alias="employeeFirstName") employee_middle_name: Optional[StrictStr] = Field(default=None, description="The middle name of the employee.", alias="employeeMiddleName") - employee_last_name: Optional[StrictStr] = Field(default=None, description="The last name of the employee.", alias="employeeLastName") + employee_last_name: StrictStr = Field(description="The last name of the employee.", alias="employeeLastName") employee_name_suffix: Optional[StrictStr] = Field(default=None, description="The name suffix of the employee.", alias="employeeNameSuffix") - tin_type: Optional[StrictStr] = Field(default=None, description="The type of TIN provided.", alias="tinType") - tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") - address: Optional[StrictStr] = Field(default=None, description="The address of the employee.") - city: Optional[StrictStr] = Field(default=None, description="The city of residence of the employee.") - state: Optional[StrictStr] = Field(default=None, description="The state of residence of the employee.") - zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of residence of the employee.") - marital_status: Optional[StrictStr] = Field(default=None, description="The marital status of the employee.", alias="maritalStatus") + tin_type: StrictStr = Field(description="Tax Identification Number (TIN) type.", alias="tinType") + tin: StrictStr = Field(description="The taxpayer identification number (TIN).") + address: Optional[StrictStr] = Field(default=None, description="The address of the employee. Required unless exempt.") + city: Optional[StrictStr] = Field(default=None, description="The city of residence of the employee. Required unless exempt.") + state: Optional[StrictStr] = Field(default=None, description="The state of residence of the employee. Required unless exempt.") + zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of residence of the employee. Required unless exempt.") + marital_status: Optional[StrictStr] = Field(default=None, description="The marital status of the employee. Required unless exempt. Available values: - Single: Single or Married filing separately - Married: Married filing jointly or qualifying surviving spouse - MarriedBut: Head of household. Check only if you're unmarried and pay more than half the costs of keeping up a home for yourself and a qualifying individual.", alias="maritalStatus") last_name_differs: Optional[StrictBool] = Field(default=None, description="Indicates whether the last name differs from prior records.", alias="lastNameDiffers") num_allowances: Optional[StrictInt] = Field(default=None, description="The number of allowances claimed by the employee.", alias="numAllowances") other_dependents: Optional[StrictInt] = Field(default=None, description="The number of dependents other than allowances.", alias="otherDependents") @@ -66,7 +65,7 @@ class W4FormRequest(BaseModel): office_code: Optional[StrictStr] = Field(default=None, description="The office code associated with the form.", alias="officeCode") e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") __properties: ClassVar[List[str]] = ["eDeliveryConsentedAt", "signature", "type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w4_form_response.py b/Avalara/SDK/models/A1099/V2/w4_form_response.py index 73277f7..d84ba57 100644 --- a/Avalara/SDK/models/A1099/V2/w4_form_response.py +++ b/Avalara/SDK/models/A1099/V2/w4_form_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -33,22 +33,23 @@ import re # noqa: F401 import json -from pydantic import ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union from Avalara.SDK.models.A1099.V2.entry_status_response import EntryStatusResponse -from Avalara.SDK.models.A1099.V2.w9_form_base_response import W9FormBaseResponse from typing import Optional, Set from typing_extensions import Self -class W4FormResponse(W9FormBaseResponse): +class W4FormResponse(BaseModel): """ W4FormResponse """ # noqa: E501 + type: Optional[StrictStr] = Field(default=None, description="The form type (always \"W4\" for this model).") employee_first_name: Optional[StrictStr] = Field(default=None, description="The first name of the employee.", alias="employeeFirstName") employee_middle_name: Optional[StrictStr] = Field(default=None, description="The middle name of the employee.", alias="employeeMiddleName") employee_last_name: Optional[StrictStr] = Field(default=None, description="The last name of the employee.", alias="employeeLastName") employee_name_suffix: Optional[StrictStr] = Field(default=None, description="The name suffix of the employee.", alias="employeeNameSuffix") - tin_type: Optional[StrictStr] = Field(default=None, description="The type of TIN provided.", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type.", alias="tinType") tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") address: Optional[StrictStr] = Field(default=None, description="The address of the employee.") city: Optional[StrictStr] = Field(default=None, description="The city of residence of the employee.") @@ -63,7 +64,30 @@ class W4FormResponse(W9FormBaseResponse): additional_withheld: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The additional amount withheld.", alias="additionalWithheld") exempt_from_withholding: Optional[StrictBool] = Field(default=None, description="Indicates whether the employee is exempt from withholding.", alias="exemptFromWithholding") office_code: Optional[StrictStr] = Field(default=None, description="The office code associated with the form.", alias="officeCode") - __properties: ClassVar[List[str]] = ["id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt", "type"] + id: Optional[StrictStr] = Field(default=None, description="The unique identifier for the form.") + entry_status: Optional[EntryStatusResponse] = Field(default=None, description="The entry status information for the form.", alias="entryStatus") + reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company.", alias="companyId") + display_name: Optional[StrictStr] = Field(default=None, description="The display name associated with the form.", alias="displayName") + email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") + archived: Optional[StrictBool] = Field(default=None, description="Indicates whether the form is archived.") + ancestor_id: Optional[StrictStr] = Field(default=None, description="Form ID of previous version.", alias="ancestorId") + signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") + signed_date: Optional[datetime] = Field(default=None, description="The date the form was signed.", alias="signedDate") + e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") + created_at: Optional[datetime] = Field(default=None, description="The creation date of the form.", alias="createdAt") + updated_at: Optional[datetime] = Field(default=None, description="The last updated date of the form.", alias="updatedAt") + __properties: ClassVar[List[str]] = ["type", "id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9']): + raise ValueError("must be one of enum values ('W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9')") + return value model_config = ConfigDict( populate_by_name=True, @@ -95,8 +119,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "type", ]) _dict = self.model_dump( @@ -149,6 +175,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "type": obj.get("type"), "id": obj.get("id"), "entryStatus": EntryStatusResponse.from_dict(obj["entryStatus"]) if obj.get("entryStatus") is not None else None, "referenceId": obj.get("referenceId"), @@ -161,8 +188,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "signedDate": obj.get("signedDate"), "eDeliveryConsentedAt": obj.get("eDeliveryConsentedAt"), "createdAt": obj.get("createdAt"), - "updatedAt": obj.get("updatedAt"), - "type": obj.get("type") + "updatedAt": obj.get("updatedAt") }) return _obj diff --git a/Avalara/SDK/models/A1099/V2/w8_ben_e_form_minimal_request.py b/Avalara/SDK/models/A1099/V2/w8_ben_e_form_minimal_request.py index 3395584..141dc5e 100644 --- a/Avalara/SDK/models/A1099/V2/w8_ben_e_form_minimal_request.py +++ b/Avalara/SDK/models/A1099/V2/w8_ben_e_form_minimal_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -47,7 +47,7 @@ class W8BenEFormMinimalRequest(BaseModel): email: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The email address of the individual associated with the form.") name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The name of the individual or entity associated with the form.") reference_number: Optional[StrictStr] = Field(default=None, description="A reference number for the form.", alias="referenceNumber") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") __properties: ClassVar[List[str]] = ["type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w8_ben_e_form_request.py b/Avalara/SDK/models/A1099/V2/w8_ben_e_form_request.py index 8c65314..f06f5cb 100644 --- a/Avalara/SDK/models/A1099/V2/w8_ben_e_form_request.py +++ b/Avalara/SDK/models/A1099/V2/w8_ben_e_form_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -36,7 +36,6 @@ from datetime import date, datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing_extensions import Annotated from Avalara.SDK.models.A1099.V2.substantial_us_owner_request import SubstantialUsOwnerRequest from typing import Optional, Set from typing_extensions import Self @@ -46,17 +45,17 @@ class W8BenEFormRequest(BaseModel): W8BenEFormRequest """ # noqa: E501 type: Optional[StrictStr] = Field(default=None, description="The form type (always \"w8bene\" for this model).") - name: Optional[StrictStr] = Field(default=None, description="The name of the individual or entity associated with the form.") - citizenship_country: Optional[StrictStr] = Field(default=None, description="The country of citizenship.", alias="citizenshipCountry") + name: StrictStr = Field(description="The name of the individual or entity associated with the form.") + citizenship_country: StrictStr = Field(description="The country of citizenship.", alias="citizenshipCountry") disregarded_entity: Optional[StrictStr] = Field(default=None, description="The name of the disregarded entity receiving the payment (if applicable).", alias="disregardedEntity") - entity_type: Optional[StrictStr] = Field(default=None, description="The entity type.", alias="entityType") + entity_type: StrictStr = Field(description="The entity type. Available values: - 1: Corporation - 2: Disregarded entity - 3: Partnership - 4: Simple trust - 5: Grantor trust - 6: Complex trust - 7: Estate - 8: Foreign Government - Controlled Entity - 9: Central Bank of Issue - 10: Tax-exempt organization - 11: Private foundation - 12: International organization - 13: Foreign Government - Controlled Integral Part", alias="entityType") making_treaty_claim: Optional[StrictBool] = Field(default=None, description="Indicates whether the entity is making a treaty claim.", alias="makingTreatyClaim") - fatca_status: Optional[StrictStr] = Field(default=None, description="The FATCA status.", alias="fatcaStatus") + fatca_status: StrictStr = Field(description="The FATCA status. Available values: - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner) - 2: Participating FFI - 3: Reporting Model 1 FFI - 4: Reporting Model 2 FFI - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII) - 6: Sponsored FFI that has not obtained a GIIN - 7: Certified deemed-compliant nonregistering local bank - 8: Certified deemed-compliant FFI with only low-value accounts - 9: Certified deemed-compliant sponsored, closely held investment vehicle - 10: Certified deemed-compliant limited life debt investment entity - 11: Certified deemed-compliant investment advisors and investment managers - 12: Owner-documented FFI - 13: Restricted distributor - 14: Nonreporting IGA FFI - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue - 16: International organization - 17: Exempt retirement plans - 18: Entity wholly owned by exempt beneficial owners - 19: Territory financial institution - 20: Nonfinancial group entity - 21: Excepted nonfinancial start-up company - 22: Excepted nonfinancial entity in liquidation or bankruptcy - 23: 501(c) organization - 24: Nonprofit organization - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation - 26: Excepted territory NFFE - 27: Active NFFE - 28: Passive NFFE - 29: Excepted inter-affiliate FFI - 30: Direct reporting NFFE - 31: Sponsored direct reporting NFFE - 32: Account that is not a financial account", alias="fatcaStatus") residence_address: Optional[StrictStr] = Field(default=None, description="The residential address of the individual or entity.", alias="residenceAddress") residence_city: Optional[StrictStr] = Field(default=None, description="The city of residence.", alias="residenceCity") residence_state: Optional[StrictStr] = Field(default=None, description="The state of residence.", alias="residenceState") residence_zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the residence.", alias="residenceZip") - residence_country: Optional[StrictStr] = Field(default=None, description="The country of residence.", alias="residenceCountry") + residence_country: StrictStr = Field(description="The country of residence.", alias="residenceCountry") residence_is_mailing: Optional[StrictBool] = Field(default=None, description="Indicates whether the residence address is also the mailing address.", alias="residenceIsMailing") mailing_address: Optional[StrictStr] = Field(default=None, description="The mailing address.", alias="mailingAddress") mailing_city: Optional[StrictStr] = Field(default=None, description="The city of the mailing address.", alias="mailingCity") @@ -68,7 +67,7 @@ class W8BenEFormRequest(BaseModel): foreign_tin_not_required: Optional[StrictBool] = Field(default=None, description="Indicates whether a foreign TIN is not required.", alias="foreignTinNotRequired") foreign_tin: Optional[StrictStr] = Field(default=None, description="The foreign taxpayer identification number (TIN).", alias="foreignTin") reference_number: Optional[StrictStr] = Field(default=None, description="A reference number for the form.", alias="referenceNumber") - disregarded_entity_fatca_status: Optional[StrictStr] = Field(default=None, description="The FATCA status of disregarded entity or branch receiving payment.", alias="disregardedEntityFatcaStatus") + disregarded_entity_fatca_status: Optional[StrictStr] = Field(default=None, description="The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Limited Branch - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI", alias="disregardedEntityFatcaStatus") disregarded_address: Optional[StrictStr] = Field(default=None, description="The address for disregarded entities.", alias="disregardedAddress") disregarded_city: Optional[StrictStr] = Field(default=None, description="The city for disregarded entities.", alias="disregardedCity") disregarded_state: Optional[StrictStr] = Field(default=None, description="The state for disregarded entities.", alias="disregardedState") @@ -78,7 +77,7 @@ class W8BenEFormRequest(BaseModel): treaty_country_certification: Optional[StrictBool] = Field(default=None, description="Certifies the beneficial owner's country under the U.S. tax treaty.", alias="treatyCountryCertification") treaty_country: Optional[StrictStr] = Field(default=None, description="The treaty country of the beneficial owner.", alias="treatyCountry") benefit_limitation_certification: Optional[StrictBool] = Field(default=None, description="Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements.", alias="benefitLimitationCertification") - benefit_limitation: Optional[StrictStr] = Field(default=None, description="The benefit limitation for tax treaty claims.", alias="benefitLimitation") + benefit_limitation: Optional[StrictStr] = Field(default=None, description="The benefit limitation for tax treaty claims. Available values: - 1: Government - 2: Tax exempt pension trust or pension fund - 3: Other tax exempt organization - 4: Publicly traded corporation - 5: Subsidiary of a publicly traded corporation - 6: Company that meets the ownership and base erosion test - 7: Company that meets the derivative benefits test - 8: Company with an item of income that meets active trade or business test - 9: Favorable discretionary determination by the U.S. competent authority received - 10: Other", alias="benefitLimitation") qualified_resident_status_certification: Optional[StrictBool] = Field(default=None, description="Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income.", alias="qualifiedResidentStatusCertification") treaty_article: Optional[StrictStr] = Field(default=None, description="Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits.", alias="treatyArticle") withholding_rate: Optional[StrictStr] = Field(default=None, description="Specifies the reduced withholding rate claimed under the applicable tax treaty.", alias="withholdingRate") @@ -102,7 +101,7 @@ class W8BenEFormRequest(BaseModel): restricted_distributor_preexisting_sales_compliance_certification: Optional[StrictBool] = Field(default=None, description="Certifies that the entity complies with distribution restrictions for U.S.-linked investors and has addressed any preexisting sales in accordance with FATCA regulations.", alias="restrictedDistributorPreexistingSalesComplianceCertification") nonreporting_iga_ffi_certification: Optional[StrictBool] = Field(default=None, description="Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA.", alias="nonreportingIgaFfiCertification") iga_country: Optional[StrictStr] = Field(default=None, description="The country for the applicable IGA with the United States.", alias="igaCountry") - iga_model: Optional[StrictStr] = Field(default=None, description="The applicable IGA model.", alias="igaModel") + iga_model: Optional[StrictStr] = Field(default=None, description="The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA", alias="igaModel") iga_legal_status_treatment: Optional[StrictStr] = Field(default=None, description="Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations.", alias="igaLegalStatusTreatment") iga_ffi_trustee_or_sponsor: Optional[StrictStr] = Field(default=None, description="The trustee or sponsor name for the nonreporting IGA FFI.", alias="igaFfiTrusteeOrSponsor") iga_ffi_trustee_is_foreign: Optional[StrictBool] = Field(default=None, description="Indicates whether the trustee for the nonreporting IGA FFI is foreign.", alias="igaFfiTrusteeIsForeign") @@ -143,7 +142,7 @@ class W8BenEFormRequest(BaseModel): capacity_to_sign_certification: Optional[StrictBool] = Field(default=None, description="Certifies signer has the capacity to sign for the beneficial owner.", alias="capacityToSignCertification") e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") __properties: ClassVar[List[str]] = ["eDeliveryConsentedAt", "signature", "type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w8_ben_e_form_response.py b/Avalara/SDK/models/A1099/V2/w8_ben_e_form_response.py index ebe1dab..d251233 100644 --- a/Avalara/SDK/models/A1099/V2/w8_ben_e_form_response.py +++ b/Avalara/SDK/models/A1099/V2/w8_ben_e_form_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -33,19 +33,19 @@ import re # noqa: F401 import json -from datetime import date -from pydantic import ConfigDict, Field, StrictBool, StrictStr +from datetime import date, datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from Avalara.SDK.models.A1099.V2.entry_status_response import EntryStatusResponse from Avalara.SDK.models.A1099.V2.substantial_us_owner_response import SubstantialUsOwnerResponse -from Avalara.SDK.models.A1099.V2.w9_form_base_response import W9FormBaseResponse from typing import Optional, Set from typing_extensions import Self -class W8BenEFormResponse(W9FormBaseResponse): +class W8BenEFormResponse(BaseModel): """ W8BenEFormResponse """ # noqa: E501 + type: Optional[StrictStr] = Field(default=None, description="The form type (always \"W8BenE\" for this model).") name: Optional[StrictStr] = Field(default=None, description="The name of the individual or entity associated with the form.") citizenship_country: Optional[StrictStr] = Field(default=None, description="The country of citizenship.", alias="citizenshipCountry") disregarded_entity: Optional[StrictStr] = Field(default=None, description="The name of the disregarded entity receiving the payment (if applicable).", alias="disregardedEntity") @@ -63,7 +63,7 @@ class W8BenEFormResponse(W9FormBaseResponse): mailing_state: Optional[StrictStr] = Field(default=None, description="The state of the mailing address.", alias="mailingState") mailing_zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the mailing address.", alias="mailingZip") mailing_country: Optional[StrictStr] = Field(default=None, description="The country of the mailing address.", alias="mailingCountry") - tin_type: Optional[StrictStr] = Field(default=None, description="The type of TIN provided.", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type.", alias="tinType") tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") giin: Optional[StrictStr] = Field(default=None, description="The global intermediary identification number (GIIN).") foreign_tin_not_required: Optional[StrictBool] = Field(default=None, description="Indicates whether a foreign TIN is not required.", alias="foreignTinNotRequired") @@ -142,7 +142,30 @@ class W8BenEFormResponse(W9FormBaseResponse): substantial_us_owners: Optional[List[SubstantialUsOwnerResponse]] = Field(default=None, description="The list of substantial U.S. owners of passive NFFE.", alias="substantialUsOwners") signer_name: Optional[StrictStr] = Field(default=None, description="The name of the signer.", alias="signerName") capacity_to_sign_certification: Optional[StrictBool] = Field(default=None, description="Certifies signer has the capacity to sign for the beneficial owner.", alias="capacityToSignCertification") - __properties: ClassVar[List[str]] = ["id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt", "type"] + id: Optional[StrictStr] = Field(default=None, description="The unique identifier for the form.") + entry_status: Optional[EntryStatusResponse] = Field(default=None, description="The entry status information for the form.", alias="entryStatus") + reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company.", alias="companyId") + display_name: Optional[StrictStr] = Field(default=None, description="The display name associated with the form.", alias="displayName") + email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") + archived: Optional[StrictBool] = Field(default=None, description="Indicates whether the form is archived.") + ancestor_id: Optional[StrictStr] = Field(default=None, description="Form ID of previous version.", alias="ancestorId") + signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") + signed_date: Optional[datetime] = Field(default=None, description="The date the form was signed.", alias="signedDate") + e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") + created_at: Optional[datetime] = Field(default=None, description="The creation date of the form.", alias="createdAt") + updated_at: Optional[datetime] = Field(default=None, description="The last updated date of the form.", alias="updatedAt") + __properties: ClassVar[List[str]] = ["type", "id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9']): + raise ValueError("must be one of enum values ('W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9')") + return value model_config = ConfigDict( populate_by_name=True, @@ -174,8 +197,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "type", ]) _dict = self.model_dump( @@ -228,6 +253,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "type": obj.get("type"), "id": obj.get("id"), "entryStatus": EntryStatusResponse.from_dict(obj["entryStatus"]) if obj.get("entryStatus") is not None else None, "referenceId": obj.get("referenceId"), @@ -240,8 +266,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "signedDate": obj.get("signedDate"), "eDeliveryConsentedAt": obj.get("eDeliveryConsentedAt"), "createdAt": obj.get("createdAt"), - "updatedAt": obj.get("updatedAt"), - "type": obj.get("type") + "updatedAt": obj.get("updatedAt") }) return _obj diff --git a/Avalara/SDK/models/A1099/V2/w8_ben_form_data_model.py b/Avalara/SDK/models/A1099/V2/w8_ben_form_data_model.py index 84f65dc..e59a05d 100644 --- a/Avalara/SDK/models/A1099/V2/w8_ben_form_data_model.py +++ b/Avalara/SDK/models/A1099/V2/w8_ben_form_data_model.py @@ -36,7 +36,7 @@ from datetime import date, datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union -from Avalara.SDK.models.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel from typing import Optional, Set from typing_extensions import Self diff --git a/Avalara/SDK/models/A1099/V2/w8_ben_form_minimal_request.py b/Avalara/SDK/models/A1099/V2/w8_ben_form_minimal_request.py index 9c01d58..9dec6db 100644 --- a/Avalara/SDK/models/A1099/V2/w8_ben_form_minimal_request.py +++ b/Avalara/SDK/models/A1099/V2/w8_ben_form_minimal_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -47,7 +47,7 @@ class W8BenFormMinimalRequest(BaseModel): email: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The email address of the individual associated with the form.") name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The name of the individual or entity associated with the form.") reference_number: Optional[StrictStr] = Field(default=None, description="A reference number for the form.", alias="referenceNumber") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") __properties: ClassVar[List[str]] = ["type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w8_ben_form_request.py b/Avalara/SDK/models/A1099/V2/w8_ben_form_request.py index 240a865..e2d9f20 100644 --- a/Avalara/SDK/models/A1099/V2/w8_ben_form_request.py +++ b/Avalara/SDK/models/A1099/V2/w8_ben_form_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -36,7 +36,6 @@ from datetime import date, datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -45,19 +44,19 @@ class W8BenFormRequest(BaseModel): W8BenFormRequest """ # noqa: E501 type: Optional[StrictStr] = Field(default=None, description="The form type (always \"w8ben\" for this model).") - name: Optional[StrictStr] = Field(default=None, description="The name of the individual or entity associated with the form.") - citizenship_country: Optional[StrictStr] = Field(default=None, description="The country of citizenship.", alias="citizenshipCountry") + name: StrictStr = Field(description="The name of the individual or entity associated with the form.") + citizenship_country: StrictStr = Field(description="The country of citizenship.", alias="citizenshipCountry") residence_address: Optional[StrictStr] = Field(default=None, description="The residential address of the individual or entity.", alias="residenceAddress") residence_city: Optional[StrictStr] = Field(default=None, description="The city of residence.", alias="residenceCity") residence_state: Optional[StrictStr] = Field(default=None, description="The state of residence.", alias="residenceState") residence_zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the residence.", alias="residenceZip") - residence_country: Optional[StrictStr] = Field(default=None, description="The country of residence.", alias="residenceCountry") + residence_country: StrictStr = Field(description="The country of residence.", alias="residenceCountry") residence_is_mailing: Optional[StrictBool] = Field(default=None, description="Indicates whether the residence address is the mailing address.", alias="residenceIsMailing") mailing_address: Optional[StrictStr] = Field(default=None, description="The mailing address.", alias="mailingAddress") mailing_city: Optional[StrictStr] = Field(default=None, description="The city of the mailing address.", alias="mailingCity") mailing_state: Optional[StrictStr] = Field(default=None, description="The state of the mailing address.", alias="mailingState") mailing_zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the mailing address.", alias="mailingZip") - mailing_country: Optional[StrictStr] = Field(default=None, description="The country of the mailing address.", alias="mailingCountry") + mailing_country: Optional[StrictStr] = Field(description="The country of the mailing address.", alias="mailingCountry") tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") foreign_tin_not_required: Optional[StrictBool] = Field(default=None, description="Indicates whether a foreign TIN is not legally required.", alias="foreignTinNotRequired") foreign_tin: Optional[StrictStr] = Field(default=None, description="The foreign taxpayer identification number (TIN).", alias="foreignTin") @@ -71,7 +70,7 @@ class W8BenFormRequest(BaseModel): signer_name: Optional[StrictStr] = Field(default=None, description="The name of the signer of the form.", alias="signerName") e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") __properties: ClassVar[List[str]] = ["eDeliveryConsentedAt", "signature", "type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w8_ben_form_response.py b/Avalara/SDK/models/A1099/V2/w8_ben_form_response.py index be5b77d..a4d7313 100644 --- a/Avalara/SDK/models/A1099/V2/w8_ben_form_response.py +++ b/Avalara/SDK/models/A1099/V2/w8_ben_form_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -33,18 +33,18 @@ import re # noqa: F401 import json -from datetime import date -from pydantic import ConfigDict, Field, StrictBool, StrictStr +from datetime import date, datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from Avalara.SDK.models.A1099.V2.entry_status_response import EntryStatusResponse -from Avalara.SDK.models.A1099.V2.w9_form_base_response import W9FormBaseResponse from typing import Optional, Set from typing_extensions import Self -class W8BenFormResponse(W9FormBaseResponse): +class W8BenFormResponse(BaseModel): """ W8BenFormResponse """ # noqa: E501 + type: Optional[StrictStr] = Field(default=None, description="The form type (always \"W8Ben\" for this model).") name: Optional[StrictStr] = Field(default=None, description="The name of the individual or entity associated with the form.") citizenship_country: Optional[StrictStr] = Field(default=None, description="The country of citizenship.", alias="citizenshipCountry") residence_address: Optional[StrictStr] = Field(default=None, description="The residential address of the individual or entity.", alias="residenceAddress") @@ -58,7 +58,7 @@ class W8BenFormResponse(W9FormBaseResponse): mailing_state: Optional[StrictStr] = Field(default=None, description="The state of the mailing address.", alias="mailingState") mailing_zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the mailing address.", alias="mailingZip") mailing_country: Optional[StrictStr] = Field(default=None, description="The country of the mailing address.", alias="mailingCountry") - tin_type: Optional[StrictStr] = Field(default=None, description="The type of TIN provided.", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type.", alias="tinType") tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") foreign_tin_not_required: Optional[StrictBool] = Field(default=None, description="Indicates whether a foreign TIN is not required.", alias="foreignTinNotRequired") foreign_tin: Optional[StrictStr] = Field(default=None, description="The foreign taxpayer identification number (TIN).", alias="foreignTin") @@ -71,7 +71,30 @@ class W8BenFormResponse(W9FormBaseResponse): income_type: Optional[StrictStr] = Field(default=None, description="The type of income covered by the treaty.", alias="incomeType") signer_name: Optional[StrictStr] = Field(default=None, description="The name of the signer of the form.", alias="signerName") signer_capacity: Optional[StrictStr] = Field(default=None, description="The capacity in which the signer is signing the form.", alias="signerCapacity") - __properties: ClassVar[List[str]] = ["id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt", "type"] + id: Optional[StrictStr] = Field(default=None, description="The unique identifier for the form.") + entry_status: Optional[EntryStatusResponse] = Field(default=None, description="The entry status information for the form.", alias="entryStatus") + reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company.", alias="companyId") + display_name: Optional[StrictStr] = Field(default=None, description="The display name associated with the form.", alias="displayName") + email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") + archived: Optional[StrictBool] = Field(default=None, description="Indicates whether the form is archived.") + ancestor_id: Optional[StrictStr] = Field(default=None, description="Form ID of previous version.", alias="ancestorId") + signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") + signed_date: Optional[datetime] = Field(default=None, description="The date the form was signed.", alias="signedDate") + e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") + created_at: Optional[datetime] = Field(default=None, description="The creation date of the form.", alias="createdAt") + updated_at: Optional[datetime] = Field(default=None, description="The last updated date of the form.", alias="updatedAt") + __properties: ClassVar[List[str]] = ["type", "id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9']): + raise ValueError("must be one of enum values ('W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9')") + return value model_config = ConfigDict( populate_by_name=True, @@ -103,8 +126,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "type", ]) _dict = self.model_dump( @@ -157,6 +182,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "type": obj.get("type"), "id": obj.get("id"), "entryStatus": EntryStatusResponse.from_dict(obj["entryStatus"]) if obj.get("entryStatus") is not None else None, "referenceId": obj.get("referenceId"), @@ -169,8 +195,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "signedDate": obj.get("signedDate"), "eDeliveryConsentedAt": obj.get("eDeliveryConsentedAt"), "createdAt": obj.get("createdAt"), - "updatedAt": obj.get("updatedAt"), - "type": obj.get("type") + "updatedAt": obj.get("updatedAt") }) return _obj diff --git a/Avalara/SDK/models/A1099/V2/w8_bene_form_data_model.py b/Avalara/SDK/models/A1099/V2/w8_bene_form_data_model.py index 583454a..7b08c9d 100644 --- a/Avalara/SDK/models/A1099/V2/w8_bene_form_data_model.py +++ b/Avalara/SDK/models/A1099/V2/w8_bene_form_data_model.py @@ -36,7 +36,7 @@ from datetime import date, datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union -from Avalara.SDK.models.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel from typing import Optional, Set from typing_extensions import Self diff --git a/Avalara/SDK/models/A1099/V2/w8_imy_form_data_model.py b/Avalara/SDK/models/A1099/V2/w8_imy_form_data_model.py index b755038..d2e69ce 100644 --- a/Avalara/SDK/models/A1099/V2/w8_imy_form_data_model.py +++ b/Avalara/SDK/models/A1099/V2/w8_imy_form_data_model.py @@ -36,7 +36,7 @@ from datetime import date, datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union -from Avalara.SDK.models.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel from typing import Optional, Set from typing_extensions import Self diff --git a/Avalara/SDK/models/A1099/V2/w8_imy_form_minimal_request.py b/Avalara/SDK/models/A1099/V2/w8_imy_form_minimal_request.py index e5389dd..da20716 100644 --- a/Avalara/SDK/models/A1099/V2/w8_imy_form_minimal_request.py +++ b/Avalara/SDK/models/A1099/V2/w8_imy_form_minimal_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -47,7 +47,7 @@ class W8ImyFormMinimalRequest(BaseModel): email: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The email address of the individual associated with the form.") name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The name of the individual or entity associated with the form.") reference_number: Optional[StrictStr] = Field(default=None, description="A reference number for the form.", alias="referenceNumber") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") __properties: ClassVar[List[str]] = ["type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w8_imy_form_request.py b/Avalara/SDK/models/A1099/V2/w8_imy_form_request.py index c934ec8..8728f57 100644 --- a/Avalara/SDK/models/A1099/V2/w8_imy_form_request.py +++ b/Avalara/SDK/models/A1099/V2/w8_imy_form_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -36,7 +36,6 @@ from datetime import date, datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -45,28 +44,28 @@ class W8ImyFormRequest(BaseModel): W8ImyFormRequest """ # noqa: E501 type: Optional[StrictStr] = Field(default=None, description="The form type (always \"w8imy\" for this model).") - name: Optional[StrictStr] = Field(default=None, description="The name of the individual or entity associated with the form.") - citizenship_country: Optional[StrictStr] = Field(default=None, description="The country of citizenship.", alias="citizenshipCountry") + name: StrictStr = Field(description="The name of the individual or entity associated with the form.") + citizenship_country: StrictStr = Field(description="The country of citizenship.", alias="citizenshipCountry") disregarded_entity: Optional[StrictStr] = Field(default=None, description="The name of the disregarded entity receiving the payment (if applicable).", alias="disregardedEntity") - entity_type: Optional[StrictStr] = Field(default=None, description="The entity type.", alias="entityType") - fatca_status: Optional[StrictStr] = Field(default=None, description="The FATCA status.", alias="fatcaStatus") + entity_type: StrictStr = Field(description="The entity type. Available values: - 1: QI (including a QDD). Complete Part III. - 2: Nonqualified intermediary. Complete Part IV. - 3: Territory financial institution. Complete Part V. - 4: U.S. branch. Complete Part VI. - 5: Withholding foreign partnership. Complete Part VII. - 6: Withholding foreign trust. Complete Part VII. - 7: Nonwithholding foreign partnership. Complete Part VIII. - 8: Nonwithholding foreign simple trust. Complete Part VIII. - 9: Nonwithholding foreign grantor trust. Complete Part VIII.", alias="entityType") + fatca_status: Optional[StrictStr] = Field(default=None, description="The FATCA status. Available values: - 1: Nonparticipating foreign financial institution (FFI) (including an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner). Complete Part IX (if applicable). - 2: Participating FFI. - 3: Reporting Model 1 FFI. - 4: Reporting Model 2 FFI. - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XIX). - 6: Territory financial institution. Complete Part V. - 7: Sponsored FFI (other than a certified deemed-compliant sponsored, closely held investment vehicle). Complete Part X. - 8: Certified deemed-compliant nonregistering local bank. Complete Part XII. - 9: Certified deemed-compliant FFI with only low-value accounts. Complete Part XIII. - 10: Certified deemed-compliant sponsored, closely held investment vehicle. Complete Part XIV. - 11: Certified deemed-compliant limited life debt investment entity. Complete Part XV. - 12: Certain investment entities that do not maintain financial accounts. Complete Part XVI. - 13: Owner-documented FFI. Complete Part XI. - 14: Restricted distributor. Complete Part XVII. - 15: Foreign central bank of issue. Complete Part XVIII. - 16: Nonreporting IGA FFI. Complete Part XIX. - 17: Exempt retirement plans. Complete Part XX. - 18: Excepted nonfinancial group entity. Complete Part XXI. - 19: Excepted nonfinancial start-up company. Complete Part XXII. - 20: Excepted nonfinancial entity in liquidation or bankruptcy. Complete Part XXIII. - 21: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation. Complete Part XXIV. - 22: Excepted territory NFFE. Complete Part XXV. - 23: Active NFFE. Complete Part XXVI. - 24: Passive NFFE. Complete Part XXVII. - 25: Direct reporting NFFE. - 26: Sponsored direct reporting NFFE. Complete Part XXVIII.", alias="fatcaStatus") residence_address: Optional[StrictStr] = Field(default=None, description="The residential address of the individual or entity.", alias="residenceAddress") residence_city: Optional[StrictStr] = Field(default=None, description="The city of residence.", alias="residenceCity") residence_state: Optional[StrictStr] = Field(default=None, description="The state of residence.", alias="residenceState") residence_zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the residence.", alias="residenceZip") - residence_country: Optional[StrictStr] = Field(default=None, description="The country of residence.", alias="residenceCountry") + residence_country: StrictStr = Field(description="The country of residence.", alias="residenceCountry") residence_is_mailing: Optional[StrictBool] = Field(default=None, description="Indicates whether the residence address is also the mailing address.", alias="residenceIsMailing") mailing_address: Optional[StrictStr] = Field(default=None, description="The mailing address.", alias="mailingAddress") mailing_city: Optional[StrictStr] = Field(default=None, description="The city of the mailing address.", alias="mailingCity") mailing_state: Optional[StrictStr] = Field(default=None, description="The state of the mailing address.", alias="mailingState") mailing_zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the mailing address.", alias="mailingZip") mailing_country: Optional[StrictStr] = Field(default=None, description="The country of the mailing address.", alias="mailingCountry") - tin_type: Optional[StrictStr] = Field(default=None, description="The type of TIN provided.", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type. Available values: - QI-EIN: Qualified Intermediary EIN - WP-EIN: Withholding Partnership EIN - WT-EIN: Withholding Trust EIN - EIN: Employer Identification Number", alias="tinType") tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") giin: Optional[StrictStr] = Field(default=None, description="The global intermediary identification number (GIIN).") foreign_tin: Optional[StrictStr] = Field(default=None, description="The foreign taxpayer identification number (TIN).", alias="foreignTin") reference_number: Optional[StrictStr] = Field(default=None, description="A reference number for the form.", alias="referenceNumber") - disregarded_entity_fatca_status: Optional[StrictStr] = Field(default=None, description="The FATCA status of disregarded entity or branch receiving payment.", alias="disregardedEntityFatcaStatus") + disregarded_entity_fatca_status: Optional[StrictStr] = Field(default=None, description="The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Branch treated as nonparticipating FFI. - 2: Participating FFI. - 3: Reporting Model 1 FFI. - 4: Reporting Model 2 FFI. - 5: U.S. Branch", alias="disregardedEntityFatcaStatus") disregarded_address: Optional[StrictStr] = Field(default=None, description="The address for disregarded entities.", alias="disregardedAddress") disregarded_city: Optional[StrictStr] = Field(default=None, description="The city for disregarded entities.", alias="disregardedCity") disregarded_state: Optional[StrictStr] = Field(default=None, description="The state for disregarded entities.", alias="disregardedState") @@ -130,7 +129,7 @@ class W8ImyFormRequest(BaseModel): foreign_central_bank_of_issue_certification: Optional[StrictBool] = Field(default=None, description="Certifies that the entity is treated as the beneficial owner of the payment solely for purposes of chapter 4 under Regulations section 1.1471-6(d)(4).", alias="foreignCentralBankOfIssueCertification") nonreporting_iga_ffi_certification: Optional[StrictBool] = Field(default=None, description="Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA.", alias="nonreportingIgaFfiCertification") iga_country: Optional[StrictStr] = Field(default=None, description="The country for the applicable IGA with the United States.", alias="igaCountry") - iga_model: Optional[StrictStr] = Field(default=None, description="The applicable IGA model.", alias="igaModel") + iga_model: Optional[StrictStr] = Field(default=None, description="The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA", alias="igaModel") iga_legal_status_treatment: Optional[StrictStr] = Field(default=None, description="Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations.", alias="igaLegalStatusTreatment") iga_ffi_trustee_or_sponsor: Optional[StrictStr] = Field(default=None, description="The trustee or sponsor name for the nonreporting IGA FFI.", alias="igaFfiTrusteeOrSponsor") iga_ffi_trustee_is_foreign: Optional[StrictBool] = Field(default=None, description="Indicates whether the trustee for the nonreporting IGA FFI is foreign.", alias="igaFfiTrusteeIsForeign") @@ -158,7 +157,7 @@ class W8ImyFormRequest(BaseModel): signer_name: Optional[StrictStr] = Field(default=None, description="The name of the signer.", alias="signerName") e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") __properties: ClassVar[List[str]] = ["eDeliveryConsentedAt", "signature", "type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w8_imy_form_response.py b/Avalara/SDK/models/A1099/V2/w8_imy_form_response.py index 5b4a6b0..1db503e 100644 --- a/Avalara/SDK/models/A1099/V2/w8_imy_form_response.py +++ b/Avalara/SDK/models/A1099/V2/w8_imy_form_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -33,18 +33,18 @@ import re # noqa: F401 import json -from datetime import date -from pydantic import ConfigDict, Field, StrictBool, StrictStr +from datetime import date, datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from Avalara.SDK.models.A1099.V2.entry_status_response import EntryStatusResponse -from Avalara.SDK.models.A1099.V2.w9_form_base_response import W9FormBaseResponse from typing import Optional, Set from typing_extensions import Self -class W8ImyFormResponse(W9FormBaseResponse): +class W8ImyFormResponse(BaseModel): """ W8ImyFormResponse """ # noqa: E501 + type: Optional[StrictStr] = Field(default=None, description="The form type (always \"W8Imy\" for this model).") name: Optional[StrictStr] = Field(default=None, description="The name of the individual or entity associated with the form.") citizenship_country: Optional[StrictStr] = Field(default=None, description="The country of citizenship.", alias="citizenshipCountry") disregarded_entity: Optional[StrictStr] = Field(default=None, description="The name of the disregarded entity receiving the payment (if applicable).", alias="disregardedEntity") @@ -61,7 +61,7 @@ class W8ImyFormResponse(W9FormBaseResponse): mailing_state: Optional[StrictStr] = Field(default=None, description="The state of the mailing address.", alias="mailingState") mailing_zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the mailing address.", alias="mailingZip") mailing_country: Optional[StrictStr] = Field(default=None, description="The country of the mailing address.", alias="mailingCountry") - tin_type: Optional[StrictStr] = Field(default=None, description="The type of TIN provided.", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type.", alias="tinType") tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") giin: Optional[StrictStr] = Field(default=None, description="The global intermediary identification number (GIIN).") foreign_tin: Optional[StrictStr] = Field(default=None, description="The foreign taxpayer identification number (TIN).", alias="foreignTin") @@ -156,7 +156,30 @@ class W8ImyFormResponse(W9FormBaseResponse): sponsored_direct_reporting_nffe_certification: Optional[StrictBool] = Field(default=None, description="Certifies that the entity is a sponsored direct reporting NFFE.", alias="sponsoredDirectReportingNffeCertification") direct_reporting_nffe_sponsoring_entity: Optional[StrictStr] = Field(default=None, description="The name of the entity that sponsors the direct reporting NFFE.", alias="directReportingNffeSponsoringEntity") signer_name: Optional[StrictStr] = Field(default=None, description="The name of the signer.", alias="signerName") - __properties: ClassVar[List[str]] = ["id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt", "type"] + id: Optional[StrictStr] = Field(default=None, description="The unique identifier for the form.") + entry_status: Optional[EntryStatusResponse] = Field(default=None, description="The entry status information for the form.", alias="entryStatus") + reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company.", alias="companyId") + display_name: Optional[StrictStr] = Field(default=None, description="The display name associated with the form.", alias="displayName") + email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") + archived: Optional[StrictBool] = Field(default=None, description="Indicates whether the form is archived.") + ancestor_id: Optional[StrictStr] = Field(default=None, description="Form ID of previous version.", alias="ancestorId") + signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") + signed_date: Optional[datetime] = Field(default=None, description="The date the form was signed.", alias="signedDate") + e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") + created_at: Optional[datetime] = Field(default=None, description="The creation date of the form.", alias="createdAt") + updated_at: Optional[datetime] = Field(default=None, description="The last updated date of the form.", alias="updatedAt") + __properties: ClassVar[List[str]] = ["type", "id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9']): + raise ValueError("must be one of enum values ('W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9')") + return value model_config = ConfigDict( populate_by_name=True, @@ -188,8 +211,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "type", ]) _dict = self.model_dump( @@ -242,6 +267,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "type": obj.get("type"), "id": obj.get("id"), "entryStatus": EntryStatusResponse.from_dict(obj["entryStatus"]) if obj.get("entryStatus") is not None else None, "referenceId": obj.get("referenceId"), @@ -254,8 +280,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "signedDate": obj.get("signedDate"), "eDeliveryConsentedAt": obj.get("eDeliveryConsentedAt"), "createdAt": obj.get("createdAt"), - "updatedAt": obj.get("updatedAt"), - "type": obj.get("type") + "updatedAt": obj.get("updatedAt") }) return _obj diff --git a/Avalara/SDK/models/A1099/V2/w9_form_base_minimal_request.py b/Avalara/SDK/models/A1099/V2/w9_form_base_minimal_request.py index 8ab0da7..eed5ab5 100644 --- a/Avalara/SDK/models/A1099/V2/w9_form_base_minimal_request.py +++ b/Avalara/SDK/models/A1099/V2/w9_form_base_minimal_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -35,7 +35,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -44,7 +43,7 @@ class W9FormBaseMinimalRequest(BaseModel): W9FormBaseMinimalRequest """ # noqa: E501 type: Optional[StrictStr] = Field(default=None, description="The form type.") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") __properties: ClassVar[List[str]] = ["type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w9_form_base_request.py b/Avalara/SDK/models/A1099/V2/w9_form_base_request.py index 0c24def..a5dc0ca 100644 --- a/Avalara/SDK/models/A1099/V2/w9_form_base_request.py +++ b/Avalara/SDK/models/A1099/V2/w9_form_base_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -36,7 +36,6 @@ from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -47,7 +46,7 @@ class W9FormBaseRequest(BaseModel): e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") type: Optional[StrictStr] = Field(default=None, description="The form type.") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") __properties: ClassVar[List[str]] = ["type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w9_form_base_response.py b/Avalara/SDK/models/A1099/V2/w9_form_base_response.py index c936dd8..f7f57fd 100644 --- a/Avalara/SDK/models/A1099/V2/w9_form_base_response.py +++ b/Avalara/SDK/models/A1099/V2/w9_form_base_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -34,25 +34,17 @@ import json from datetime import datetime -from importlib import import_module -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional from Avalara.SDK.models.A1099.V2.entry_status_response import EntryStatusResponse from typing import Optional, Set from typing_extensions import Self -from typing import TYPE_CHECKING -if TYPE_CHECKING: - from Avalara.SDK.models.A1099.V2.w4_form_response import W4FormResponse - from Avalara.SDK.models.A1099.V2.w8_ben_e_form_response import W8BenEFormResponse - from Avalara.SDK.models.A1099.V2.w8_ben_form_response import W8BenFormResponse - from Avalara.SDK.models.A1099.V2.w8_imy_form_response import W8ImyFormResponse - from Avalara.SDK.models.A1099.V2.w9_form_response import W9FormResponse - class W9FormBaseResponse(BaseModel): """ W9FormBaseResponse """ # noqa: E501 + type: Optional[StrictStr] = Field(default=None, description="The form type.") id: Optional[StrictStr] = Field(default=None, description="The unique identifier for the form.") entry_status: Optional[EntryStatusResponse] = Field(default=None, description="The entry status information for the form.", alias="entryStatus") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") @@ -66,8 +58,17 @@ class W9FormBaseResponse(BaseModel): e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") created_at: Optional[datetime] = Field(default=None, description="The creation date of the form.", alias="createdAt") updated_at: Optional[datetime] = Field(default=None, description="The last updated date of the form.", alias="updatedAt") - type: Optional[StrictStr] = Field(default=None, description="The type of the response object.") - __properties: ClassVar[List[str]] = [] + __properties: ClassVar[List[str]] = ["type", "id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9']): + raise ValueError("must be one of enum values ('W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9')") + return value model_config = ConfigDict( populate_by_name=True, @@ -76,23 +77,6 @@ class W9FormBaseResponse(BaseModel): ) - # JSON field name that stores the object type - __discriminator_property_name: ClassVar[str] = 'type' - - # discriminator mappings - __discriminator_value_class_map: ClassVar[Dict[str, str]] = { - 'W4FormResponse': 'W4FormResponse','W8BenEFormResponse': 'W8BenEFormResponse','W8BenFormResponse': 'W8BenFormResponse','W8ImyFormResponse': 'W8ImyFormResponse','W9FormResponse': 'W9FormResponse' - } - - @classmethod - def get_discriminator_value(cls, obj: Dict[str, Any]) -> Optional[str]: - """Returns the discriminator value (object type) of the data""" - discriminator_value = obj[cls.__discriminator_property_name] - if discriminator_value: - return cls.__discriminator_value_class_map.get(discriminator_value) - else: - return None - def to_str(self) -> str: """Returns the string representation of the model using alias""" return pprint.pformat(self.model_dump(by_alias=True)) @@ -103,7 +87,7 @@ def to_json(self) -> str: return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> Optional[Union[W4FormResponse, W8BenEFormResponse, W8BenFormResponse, W8ImyFormResponse, W9FormResponse]]: + def from_json(cls, json_str: str) -> Optional[Self]: """Create an instance of W9FormBaseResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) @@ -116,8 +100,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "type", ]) _dict = self.model_dump( @@ -125,26 +111,66 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of entry_status + if self.entry_status: + _dict['entryStatus'] = self.entry_status.to_dict() + # set to None if reference_id (nullable) is None + # and model_fields_set contains the field + if self.reference_id is None and "reference_id" in self.model_fields_set: + _dict['referenceId'] = None + + # set to None if email (nullable) is None + # and model_fields_set contains the field + if self.email is None and "email" in self.model_fields_set: + _dict['email'] = None + + # set to None if ancestor_id (nullable) is None + # and model_fields_set contains the field + if self.ancestor_id is None and "ancestor_id" in self.model_fields_set: + _dict['ancestorId'] = None + + # set to None if signature (nullable) is None + # and model_fields_set contains the field + if self.signature is None and "signature" in self.model_fields_set: + _dict['signature'] = None + + # set to None if signed_date (nullable) is None + # and model_fields_set contains the field + if self.signed_date is None and "signed_date" in self.model_fields_set: + _dict['signedDate'] = None + + # set to None if e_delivery_consented_at (nullable) is None + # and model_fields_set contains the field + if self.e_delivery_consented_at is None and "e_delivery_consented_at" in self.model_fields_set: + _dict['eDeliveryConsentedAt'] = None + return _dict @classmethod - def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[W4FormResponse, W8BenEFormResponse, W8BenFormResponse, W8ImyFormResponse, W9FormResponse]]: + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: """Create an instance of W9FormBaseResponse from a dict""" - # look up the object type based on discriminator mapping - object_type = cls.get_discriminator_value(obj) - if object_type == 'W4FormResponse': - return import_module("Avalara.SDK.models.A1099.V2.w4_form_response").W4FormResponse.from_dict(obj) - if object_type == 'W8BenEFormResponse': - return import_module("Avalara.SDK.models.A1099.V2.w8_ben_e_form_response").W8BenEFormResponse.from_dict(obj) - if object_type == 'W8BenFormResponse': - return import_module("Avalara.SDK.models.A1099.V2.w8_ben_form_response").W8BenFormResponse.from_dict(obj) - if object_type == 'W8ImyFormResponse': - return import_module("Avalara.SDK.models.A1099.V2.w8_imy_form_response").W8ImyFormResponse.from_dict(obj) - if object_type == 'W9FormResponse': - return import_module("Avalara.SDK.models.A1099.V2.w9_form_response").W9FormResponse.from_dict(obj) - - raise ValueError("W9FormBaseResponse failed to lookup discriminator value from " + - json.dumps(obj) + ". Discriminator property name: " + cls.__discriminator_property_name + - ", mapping: " + json.dumps(cls.__discriminator_value_class_map)) + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "type": obj.get("type"), + "id": obj.get("id"), + "entryStatus": EntryStatusResponse.from_dict(obj["entryStatus"]) if obj.get("entryStatus") is not None else None, + "referenceId": obj.get("referenceId"), + "companyId": obj.get("companyId"), + "displayName": obj.get("displayName"), + "email": obj.get("email"), + "archived": obj.get("archived"), + "ancestorId": obj.get("ancestorId"), + "signature": obj.get("signature"), + "signedDate": obj.get("signedDate"), + "eDeliveryConsentedAt": obj.get("eDeliveryConsentedAt"), + "createdAt": obj.get("createdAt"), + "updatedAt": obj.get("updatedAt") + }) + return _obj diff --git a/Avalara/SDK/models/A1099/V2/w9_form_data_model.py b/Avalara/SDK/models/A1099/V2/w9_form_data_model.py index 5b2adf7..86fd9b5 100644 --- a/Avalara/SDK/models/A1099/V2/w9_form_data_model.py +++ b/Avalara/SDK/models/A1099/V2/w9_form_data_model.py @@ -36,7 +36,7 @@ from datetime import date, datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union -from Avalara.SDK.models.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel +from Avalara.SDK.models.A1099.V2.A1099.V2.w8_ben_e_substantial_us_owner_data_model import W8BenESubstantialUsOwnerDataModel from typing import Optional, Set from typing_extensions import Self diff --git a/Avalara/SDK/models/A1099/V2/w9_form_minimal_request.py b/Avalara/SDK/models/A1099/V2/w9_form_minimal_request.py index d1eb9f4..f03b704 100644 --- a/Avalara/SDK/models/A1099/V2/w9_form_minimal_request.py +++ b/Avalara/SDK/models/A1099/V2/w9_form_minimal_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -47,7 +47,7 @@ class W9FormMinimalRequest(BaseModel): email: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The email address of the individual associated with the form.") name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The name of the individual or entity associated with the form.") account_number: Optional[StrictStr] = Field(default=None, description="The account number associated with the form.", alias="accountNumber") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") __properties: ClassVar[List[str]] = ["type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w9_form_request.py b/Avalara/SDK/models/A1099/V2/w9_form_request.py index 7198ec5..4ed977a 100644 --- a/Avalara/SDK/models/A1099/V2/w9_form_request.py +++ b/Avalara/SDK/models/A1099/V2/w9_form_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -36,7 +36,6 @@ from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -45,27 +44,27 @@ class W9FormRequest(BaseModel): W9FormRequest """ # noqa: E501 type: Optional[StrictStr] = Field(default=None, description="The form type (always \"w9\" for this model).") - name: Optional[StrictStr] = Field(default=None, description="The name of the individual or entity associated with the form.") + name: StrictStr = Field(description="The name of the individual or entity associated with the form.") business_name: Optional[StrictStr] = Field(default=None, description="The name of the business associated with the form.", alias="businessName") - business_classification: Optional[StrictStr] = Field(default=None, description="The classification of the business.", alias="businessClassification") + business_classification: StrictStr = Field(description="The classification of the business. Available values: - Individual: Individual/sole proprietor - C Corporation: C Corporation - S Corporation: S Corporation - Partnership: Partnership - Trust/estate: Trust/estate - LLC-C: Limited liability company (C Corporation) - LLC-S: Limited liability company (S Corporation) - LLC-P: Limited liability company (Partnership) - Other: Other (requires BusinessOther field to be populated)", alias="businessClassification") business_other: Optional[StrictStr] = Field(default=None, description="The classification description when \"businessClassification\" is \"Other\".", alias="businessOther") foreign_partner_owner_or_beneficiary: Optional[StrictBool] = Field(default=None, description="Indicates whether the individual is a foreign partner, owner, or beneficiary.", alias="foreignPartnerOwnerOrBeneficiary") exempt_payee_code: Optional[StrictStr] = Field(default=None, description="The exempt payee code.", alias="exemptPayeeCode") exempt_fatca_code: Optional[StrictStr] = Field(default=None, description="The exemption from FATCA reporting code.", alias="exemptFatcaCode") foreign_country_indicator: Optional[StrictBool] = Field(default=None, description="Indicates whether the individual or entity is in a foreign country.", alias="foreignCountryIndicator") - address: Optional[StrictStr] = Field(default=None, description="The address of the individual or entity.") + address: StrictStr = Field(description="The address of the individual or entity.") foreign_address: Optional[StrictStr] = Field(default=None, description="The foreign address of the individual or entity.", alias="foreignAddress") - city: Optional[StrictStr] = Field(default=None, description="The city of the address.") - state: Optional[StrictStr] = Field(default=None, description="The state of the address.") - zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the address.") + city: Optional[StrictStr] = Field(description="The city of the address.") + state: Optional[StrictStr] = Field(description="The state of the address.") + zip: Optional[StrictStr] = Field(description="The ZIP code of the address.") account_number: Optional[StrictStr] = Field(default=None, description="The account number associated with the form.", alias="accountNumber") - tin_type: Optional[StrictStr] = Field(default=None, description="The type of TIN provided.", alias="tinType") - tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") + tin_type: StrictStr = Field(description="Tax Identification Number (TIN) type. SSN/ITIN (for individuals) and EIN (for businesses).", alias="tinType") + tin: StrictStr = Field(description="The taxpayer identification number (TIN).") backup_withholding: Optional[StrictBool] = Field(default=None, description="Indicates whether backup withholding applies.", alias="backupWithholding") is1099able: Optional[StrictBool] = Field(default=None, description="Indicates whether the individual or entity should be issued a 1099 form.") e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") - company_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The ID of the associated company.", alias="companyId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company. Required when creating a form.", alias="companyId") reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") __properties: ClassVar[List[str]] = ["eDeliveryConsentedAt", "signature", "type", "companyId", "referenceId", "email"] diff --git a/Avalara/SDK/models/A1099/V2/w9_form_response.py b/Avalara/SDK/models/A1099/V2/w9_form_response.py index f668d47..29d8d15 100644 --- a/Avalara/SDK/models/A1099/V2/w9_form_response.py +++ b/Avalara/SDK/models/A1099/V2/w9_form_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -33,18 +33,19 @@ import re # noqa: F401 import json -from pydantic import ConfigDict, Field, StrictBool, StrictStr +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from Avalara.SDK.models.A1099.V2.entry_status_response import EntryStatusResponse from Avalara.SDK.models.A1099.V2.tin_match_status_response import TinMatchStatusResponse -from Avalara.SDK.models.A1099.V2.w9_form_base_response import W9FormBaseResponse from typing import Optional, Set from typing_extensions import Self -class W9FormResponse(W9FormBaseResponse): +class W9FormResponse(BaseModel): """ W9FormResponse """ # noqa: E501 + type: Optional[StrictStr] = Field(default=None, description="The form type (always \"W9\" for this model).") name: Optional[StrictStr] = Field(default=None, description="The name of the individual or entity associated with the form.") business_name: Optional[StrictStr] = Field(default=None, description="The name of the business associated with the form.", alias="businessName") business_classification: Optional[StrictStr] = Field(default=None, description="The classification of the business.", alias="businessClassification") @@ -59,12 +60,35 @@ class W9FormResponse(W9FormBaseResponse): state: Optional[StrictStr] = Field(default=None, description="The state of the address.") zip: Optional[StrictStr] = Field(default=None, description="The ZIP code of the address.") account_number: Optional[StrictStr] = Field(default=None, description="The account number associated with the form.", alias="accountNumber") - tin_type: Optional[StrictStr] = Field(default=None, description="The type of TIN provided.", alias="tinType") + tin_type: Optional[StrictStr] = Field(default=None, description="Tax Identification Number (TIN) type.", alias="tinType") tin: Optional[StrictStr] = Field(default=None, description="The taxpayer identification number (TIN).") backup_withholding: Optional[StrictBool] = Field(default=None, description="Indicates whether backup withholding applies.", alias="backupWithholding") is1099able: Optional[StrictBool] = Field(default=None, description="Indicates whether the individual or entity should be issued a 1099 form.") tin_match_status: Optional[TinMatchStatusResponse] = Field(default=None, description="The TIN Match status from IRS.", alias="tinMatchStatus") - __properties: ClassVar[List[str]] = ["id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt", "type"] + id: Optional[StrictStr] = Field(default=None, description="The unique identifier for the form.") + entry_status: Optional[EntryStatusResponse] = Field(default=None, description="The entry status information for the form.", alias="entryStatus") + reference_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for the form.", alias="referenceId") + company_id: Optional[StrictStr] = Field(default=None, description="The ID of the associated company.", alias="companyId") + display_name: Optional[StrictStr] = Field(default=None, description="The display name associated with the form.", alias="displayName") + email: Optional[StrictStr] = Field(default=None, description="The email address of the individual associated with the form.") + archived: Optional[StrictBool] = Field(default=None, description="Indicates whether the form is archived.") + ancestor_id: Optional[StrictStr] = Field(default=None, description="Form ID of previous version.", alias="ancestorId") + signature: Optional[StrictStr] = Field(default=None, description="The signature of the form.") + signed_date: Optional[datetime] = Field(default=None, description="The date the form was signed.", alias="signedDate") + e_delivery_consented_at: Optional[datetime] = Field(default=None, description="The date when e-delivery was consented.", alias="eDeliveryConsentedAt") + created_at: Optional[datetime] = Field(default=None, description="The creation date of the form.", alias="createdAt") + updated_at: Optional[datetime] = Field(default=None, description="The last updated date of the form.", alias="updatedAt") + __properties: ClassVar[List[str]] = ["type", "id", "entryStatus", "referenceId", "companyId", "displayName", "email", "archived", "ancestorId", "signature", "signedDate", "eDeliveryConsentedAt", "createdAt", "updatedAt"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9']): + raise ValueError("must be one of enum values ('W4', 'W8Ben', 'W8BenE', 'W8Imy', 'W9')") + return value model_config = ConfigDict( populate_by_name=True, @@ -96,8 +120,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "type", ]) _dict = self.model_dump( @@ -150,6 +176,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "type": obj.get("type"), "id": obj.get("id"), "entryStatus": EntryStatusResponse.from_dict(obj["entryStatus"]) if obj.get("entryStatus") is not None else None, "referenceId": obj.get("referenceId"), @@ -162,8 +189,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "signedDate": obj.get("signedDate"), "eDeliveryConsentedAt": obj.get("eDeliveryConsentedAt"), "createdAt": obj.get("createdAt"), - "updatedAt": obj.get("updatedAt"), - "type": obj.get("type") + "updatedAt": obj.get("updatedAt") }) return _obj diff --git a/Avalara/SDK/models/EInvoicing/V1/address.py b/Avalara/SDK/models/EInvoicing/V1/address.py index 6f943c5..2efbf16 100644 --- a/Avalara/SDK/models/EInvoicing/V1/address.py +++ b/Avalara/SDK/models/EInvoicing/V1/address.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/bad_download_request.py b/Avalara/SDK/models/EInvoicing/V1/bad_download_request.py index 69c918c..11c5366 100644 --- a/Avalara/SDK/models/EInvoicing/V1/bad_download_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/bad_download_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/bad_request.py b/Avalara/SDK/models/EInvoicing/V1/bad_request.py index 1e2dfc3..fb38c52 100644 --- a/Avalara/SDK/models/EInvoicing/V1/bad_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/bad_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/batch_error_detail.py b/Avalara/SDK/models/EInvoicing/V1/batch_error_detail.py index 67dd585..83265dc 100644 --- a/Avalara/SDK/models/EInvoicing/V1/batch_error_detail.py +++ b/Avalara/SDK/models/EInvoicing/V1/batch_error_detail.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/batch_search.py b/Avalara/SDK/models/EInvoicing/V1/batch_search.py index 98a89f4..dfd9cc4 100644 --- a/Avalara/SDK/models/EInvoicing/V1/batch_search.py +++ b/Avalara/SDK/models/EInvoicing/V1/batch_search.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/batch_search_list_response.py b/Avalara/SDK/models/EInvoicing/V1/batch_search_list_response.py index 11b9909..b05fb3f 100644 --- a/Avalara/SDK/models/EInvoicing/V1/batch_search_list_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/batch_search_list_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/batch_search_participants202_response.py b/Avalara/SDK/models/EInvoicing/V1/batch_search_participants202_response.py index 20a2d0a..603fbdf 100644 --- a/Avalara/SDK/models/EInvoicing/V1/batch_search_participants202_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/batch_search_participants202_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/conditional_for_field.py b/Avalara/SDK/models/EInvoicing/V1/conditional_for_field.py index cf1f89f..db579f2 100644 --- a/Avalara/SDK/models/EInvoicing/V1/conditional_for_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/conditional_for_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/consents.py b/Avalara/SDK/models/EInvoicing/V1/consents.py index b5c31d0..50c9581 100644 --- a/Avalara/SDK/models/EInvoicing/V1/consents.py +++ b/Avalara/SDK/models/EInvoicing/V1/consents.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/create_trading_partner201_response.py b/Avalara/SDK/models/EInvoicing/V1/create_trading_partner201_response.py index e5bc256..6d0861f 100644 --- a/Avalara/SDK/models/EInvoicing/V1/create_trading_partner201_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/create_trading_partner201_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response.py b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response.py index c5a56c3..833237b 100644 --- a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.py b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.py index ae52f9c..f5473f5 100644 --- a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.py +++ b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch_request.py b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch_request.py index 51772c2..e7a33f5 100644 --- a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_field.py b/Avalara/SDK/models/EInvoicing/V1/data_input_field.py index 7625564..c5a3a8e 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_field_not_used_for.py b/Avalara/SDK/models/EInvoicing/V1/data_input_field_not_used_for.py index 5d97fea..fe9d815 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_field_not_used_for.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_field_not_used_for.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_field_optional_for.py b/Avalara/SDK/models/EInvoicing/V1/data_input_field_optional_for.py index 4e6b96a..f191e3c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_field_optional_for.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_field_optional_for.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_field_required_for.py b/Avalara/SDK/models/EInvoicing/V1/data_input_field_required_for.py index a7d92cc..ea844cc 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_field_required_for.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_field_required_for.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_fields_response.py b/Avalara/SDK/models/EInvoicing/V1/data_input_fields_response.py index af9d268..bc5f623 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_fields_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_fields_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_fetch.py b/Avalara/SDK/models/EInvoicing/V1/document_fetch.py index 3fe6bf8..4ea736c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_fetch.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_fetch.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_list_response.py b/Avalara/SDK/models/EInvoicing/V1/document_list_response.py index 86f52e7..111dd6f 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_list_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_list_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_status_response.py b/Avalara/SDK/models/EInvoicing/V1/document_status_response.py index ccb90c5..0a38d8a 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_status_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_status_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_submission_error.py b/Avalara/SDK/models/EInvoicing/V1/document_submission_error.py index 54b9693..d41e481 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_submission_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_submission_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_submit_response.py b/Avalara/SDK/models/EInvoicing/V1/document_submit_response.py index 382c0c7..cc9b752 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_submit_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_submit_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_summary.py b/Avalara/SDK/models/EInvoicing/V1/document_summary.py index 6866eb4..ff8bba6 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_summary.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_summary.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/error_response.py b/Avalara/SDK/models/EInvoicing/V1/error_response.py index 803b35b..808e848 100644 --- a/Avalara/SDK/models/EInvoicing/V1/error_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/error_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/event_id.py b/Avalara/SDK/models/EInvoicing/V1/event_id.py index c9add87..06c53cc 100644 --- a/Avalara/SDK/models/EInvoicing/V1/event_id.py +++ b/Avalara/SDK/models/EInvoicing/V1/event_id.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/event_message.py b/Avalara/SDK/models/EInvoicing/V1/event_message.py index b1c8c24..63147b6 100644 --- a/Avalara/SDK/models/EInvoicing/V1/event_message.py +++ b/Avalara/SDK/models/EInvoicing/V1/event_message.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/event_payload.py b/Avalara/SDK/models/EInvoicing/V1/event_payload.py index 9e52dc0..05b9b2a 100644 --- a/Avalara/SDK/models/EInvoicing/V1/event_payload.py +++ b/Avalara/SDK/models/EInvoicing/V1/event_payload.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/event_subscription.py b/Avalara/SDK/models/EInvoicing/V1/event_subscription.py index 54a385f..21c47d7 100644 --- a/Avalara/SDK/models/EInvoicing/V1/event_subscription.py +++ b/Avalara/SDK/models/EInvoicing/V1/event_subscription.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/extension.py b/Avalara/SDK/models/EInvoicing/V1/extension.py index 7c74180..ce1ed0b 100644 --- a/Avalara/SDK/models/EInvoicing/V1/extension.py +++ b/Avalara/SDK/models/EInvoicing/V1/extension.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request.py b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request.py index 37043f8..2a76930 100644 --- a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_data_inner.py b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_data_inner.py index a66f967..8fad65f 100644 --- a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_data_inner.py +++ b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_data_inner.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_metadata.py b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_metadata.py index d67c48b..bafd562 100644 --- a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_metadata.py +++ b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_metadata.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/forbidden_error.py b/Avalara/SDK/models/EInvoicing/V1/forbidden_error.py index f630d06..75c29a1 100644 --- a/Avalara/SDK/models/EInvoicing/V1/forbidden_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/forbidden_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/hmac_signature.py b/Avalara/SDK/models/EInvoicing/V1/hmac_signature.py index ed334d1..2d874d1 100644 --- a/Avalara/SDK/models/EInvoicing/V1/hmac_signature.py +++ b/Avalara/SDK/models/EInvoicing/V1/hmac_signature.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/hmac_signature_value.py b/Avalara/SDK/models/EInvoicing/V1/hmac_signature_value.py index 008a15d..b400e81 100644 --- a/Avalara/SDK/models/EInvoicing/V1/hmac_signature_value.py +++ b/Avalara/SDK/models/EInvoicing/V1/hmac_signature_value.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/id.py b/Avalara/SDK/models/EInvoicing/V1/id.py index 80825d9..0eb3e10 100644 --- a/Avalara/SDK/models/EInvoicing/V1/id.py +++ b/Avalara/SDK/models/EInvoicing/V1/id.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/identifier.py b/Avalara/SDK/models/EInvoicing/V1/identifier.py index 192d745..35a830c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/identifier.py +++ b/Avalara/SDK/models/EInvoicing/V1/identifier.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/input_data_formats.py b/Avalara/SDK/models/EInvoicing/V1/input_data_formats.py index df6d039..2da5030 100644 --- a/Avalara/SDK/models/EInvoicing/V1/input_data_formats.py +++ b/Avalara/SDK/models/EInvoicing/V1/input_data_formats.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/internal_server_error.py b/Avalara/SDK/models/EInvoicing/V1/internal_server_error.py index eb09e0d..04c5097 100644 --- a/Avalara/SDK/models/EInvoicing/V1/internal_server_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/internal_server_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/mandate.py b/Avalara/SDK/models/EInvoicing/V1/mandate.py index ce4cc75..e18e6a2 100644 --- a/Avalara/SDK/models/EInvoicing/V1/mandate.py +++ b/Avalara/SDK/models/EInvoicing/V1/mandate.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field.py b/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field.py index f86d56d..d2a4bd1 100644 --- a/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field_namespace.py b/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field_namespace.py index 947fa32..022c432 100644 --- a/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field_namespace.py +++ b/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field_namespace.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/mandates_response.py b/Avalara/SDK/models/EInvoicing/V1/mandates_response.py index 39c9da8..c3a2290 100644 --- a/Avalara/SDK/models/EInvoicing/V1/mandates_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/mandates_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/not_found_error.py b/Avalara/SDK/models/EInvoicing/V1/not_found_error.py index 86771c8..a2b61dd 100644 --- a/Avalara/SDK/models/EInvoicing/V1/not_found_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/not_found_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/not_used_for_field.py b/Avalara/SDK/models/EInvoicing/V1/not_used_for_field.py index 8f86713..40eca59 100644 --- a/Avalara/SDK/models/EInvoicing/V1/not_used_for_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/not_used_for_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/output_data_formats.py b/Avalara/SDK/models/EInvoicing/V1/output_data_formats.py index 5e283e0..de224cf 100644 --- a/Avalara/SDK/models/EInvoicing/V1/output_data_formats.py +++ b/Avalara/SDK/models/EInvoicing/V1/output_data_formats.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/pagination.py b/Avalara/SDK/models/EInvoicing/V1/pagination.py index 198943d..1b75f79 100644 --- a/Avalara/SDK/models/EInvoicing/V1/pagination.py +++ b/Avalara/SDK/models/EInvoicing/V1/pagination.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/required_when_field.py b/Avalara/SDK/models/EInvoicing/V1/required_when_field.py index 0550d53..2557c42 100644 --- a/Avalara/SDK/models/EInvoicing/V1/required_when_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/required_when_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/search_participants200_response.py b/Avalara/SDK/models/EInvoicing/V1/search_participants200_response.py index 69a8952..e9fad80 100644 --- a/Avalara/SDK/models/EInvoicing/V1/search_participants200_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/search_participants200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/signature.py b/Avalara/SDK/models/EInvoicing/V1/signature.py index 7a46979..23f3ebc 100644 --- a/Avalara/SDK/models/EInvoicing/V1/signature.py +++ b/Avalara/SDK/models/EInvoicing/V1/signature.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/signature_signature.py b/Avalara/SDK/models/EInvoicing/V1/signature_signature.py index 81bdd63..a31c27c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/signature_signature.py +++ b/Avalara/SDK/models/EInvoicing/V1/signature_signature.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/signature_value.py b/Avalara/SDK/models/EInvoicing/V1/signature_value.py index b5f1cf1..32ef7de 100644 --- a/Avalara/SDK/models/EInvoicing/V1/signature_value.py +++ b/Avalara/SDK/models/EInvoicing/V1/signature_value.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/signature_value_signature.py b/Avalara/SDK/models/EInvoicing/V1/signature_value_signature.py index da55eda..d410592 100644 --- a/Avalara/SDK/models/EInvoicing/V1/signature_value_signature.py +++ b/Avalara/SDK/models/EInvoicing/V1/signature_value_signature.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/status_event.py b/Avalara/SDK/models/EInvoicing/V1/status_event.py index 4e89290..52201a3 100644 --- a/Avalara/SDK/models/EInvoicing/V1/status_event.py +++ b/Avalara/SDK/models/EInvoicing/V1/status_event.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/submit_document_metadata.py b/Avalara/SDK/models/EInvoicing/V1/submit_document_metadata.py index d98f1c3..430e50c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/submit_document_metadata.py +++ b/Avalara/SDK/models/EInvoicing/V1/submit_document_metadata.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/submit_interop_document202_response.py b/Avalara/SDK/models/EInvoicing/V1/submit_interop_document202_response.py index abd1e41..7a2e1a9 100644 --- a/Avalara/SDK/models/EInvoicing/V1/submit_interop_document202_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/submit_interop_document202_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/subscription_common.py b/Avalara/SDK/models/EInvoicing/V1/subscription_common.py index 58015f3..780cdba 100644 --- a/Avalara/SDK/models/EInvoicing/V1/subscription_common.py +++ b/Avalara/SDK/models/EInvoicing/V1/subscription_common.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/subscription_detail.py b/Avalara/SDK/models/EInvoicing/V1/subscription_detail.py index 19330d1..b07f651 100644 --- a/Avalara/SDK/models/EInvoicing/V1/subscription_detail.py +++ b/Avalara/SDK/models/EInvoicing/V1/subscription_detail.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/subscription_list_response.py b/Avalara/SDK/models/EInvoicing/V1/subscription_list_response.py index 2576922..0355c27 100644 --- a/Avalara/SDK/models/EInvoicing/V1/subscription_list_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/subscription_list_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/subscription_registration.py b/Avalara/SDK/models/EInvoicing/V1/subscription_registration.py index 87197f5..ce38a6f 100644 --- a/Avalara/SDK/models/EInvoicing/V1/subscription_registration.py +++ b/Avalara/SDK/models/EInvoicing/V1/subscription_registration.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/success_response.py b/Avalara/SDK/models/EInvoicing/V1/success_response.py index a117f02..c3cec0a 100644 --- a/Avalara/SDK/models/EInvoicing/V1/success_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/success_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/supported_document_types.py b/Avalara/SDK/models/EInvoicing/V1/supported_document_types.py index b93a2b3..e091aad 100644 --- a/Avalara/SDK/models/EInvoicing/V1/supported_document_types.py +++ b/Avalara/SDK/models/EInvoicing/V1/supported_document_types.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_request.py b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_request.py index 407e487..aa07000 100644 --- a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response.py b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response.py index 3a99c8c..9fd343b 100644 --- a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response_value.py b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response_value.py index fc8b413..e2c4fac 100644 --- a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response_value.py +++ b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response_value.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.py b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.py index 21c8e74..df686fd 100644 --- a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/trading_partner.py b/Avalara/SDK/models/EInvoicing/V1/trading_partner.py index 28a5ec7..c875402 100644 --- a/Avalara/SDK/models/EInvoicing/V1/trading_partner.py +++ b/Avalara/SDK/models/EInvoicing/V1/trading_partner.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/update_trading_partner200_response.py b/Avalara/SDK/models/EInvoicing/V1/update_trading_partner200_response.py index 0dd2c34..a3a1732 100644 --- a/Avalara/SDK/models/EInvoicing/V1/update_trading_partner200_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/update_trading_partner200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/validation_error.py b/Avalara/SDK/models/EInvoicing/V1/validation_error.py index b4f8f3f..da3482d 100644 --- a/Avalara/SDK/models/EInvoicing/V1/validation_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/validation_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/webhook_invocation.py b/Avalara/SDK/models/EInvoicing/V1/webhook_invocation.py index 94090de..7e8da31 100644 --- a/Avalara/SDK/models/EInvoicing/V1/webhook_invocation.py +++ b/Avalara/SDK/models/EInvoicing/V1/webhook_invocation.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/webhooks_error_info.py b/Avalara/SDK/models/EInvoicing/V1/webhooks_error_info.py index 44760ba..4a694a6 100644 --- a/Avalara/SDK/models/EInvoicing/V1/webhooks_error_info.py +++ b/Avalara/SDK/models/EInvoicing/V1/webhooks_error_info.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/webhooks_error_response.py b/Avalara/SDK/models/EInvoicing/V1/webhooks_error_response.py index 02fff70..94926cf 100644 --- a/Avalara/SDK/models/EInvoicing/V1/webhooks_error_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/webhooks_error_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/workflow_ids.py b/Avalara/SDK/models/EInvoicing/V1/workflow_ids.py index 2c64ae4..9369cdd 100644 --- a/Avalara/SDK/models/EInvoicing/V1/workflow_ids.py +++ b/Avalara/SDK/models/EInvoicing/V1/workflow_ids.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/README.md b/README.md index cfac16c..2a9a7c7 100644 --- a/README.md +++ b/README.md @@ -288,18 +288,14 @@ Class | Method | HTTP request | Description ### A1099 V2 Model Documentation - - [Avalara.SDK.models.A1099.V2.AuthorizedApiRequestModel](docs/A1099/V2/AuthorizedApiRequestModel.md) - - [Avalara.SDK.models.A1099.V2.AuthorizedApiRequestV2DataModel](docs/A1099/V2/AuthorizedApiRequestV2DataModel.md) - - [Avalara.SDK.models.A1099.V2.CompanyCreateUpdateRequestModel](docs/A1099/V2/CompanyCreateUpdateRequestModel.md) + - [Avalara.SDK.models.A1099.V2.CompanyBase](docs/A1099/V2/CompanyBase.md) + - [Avalara.SDK.models.A1099.V2.CompanyRequest](docs/A1099/V2/CompanyRequest.md) - [Avalara.SDK.models.A1099.V2.CompanyResponse](docs/A1099/V2/CompanyResponse.md) - [Avalara.SDK.models.A1099.V2.CoveredIndividual](docs/A1099/V2/CoveredIndividual.md) - [Avalara.SDK.models.A1099.V2.CreateAndSendW9FormEmailRequest](docs/A1099/V2/CreateAndSendW9FormEmailRequest.md) - - [Avalara.SDK.models.A1099.V2.CreateCompanyRequest](docs/A1099/V2/CreateCompanyRequest.md) - - [Avalara.SDK.models.A1099.V2.CreateIssuerRequest](docs/A1099/V2/CreateIssuerRequest.md) - [Avalara.SDK.models.A1099.V2.CreateW9Form201Response](docs/A1099/V2/CreateW9Form201Response.md) - [Avalara.SDK.models.A1099.V2.CreateW9FormRequest](docs/A1099/V2/CreateW9FormRequest.md) - [Avalara.SDK.models.A1099.V2.EntryStatusResponse](docs/A1099/V2/EntryStatusResponse.md) - - [Avalara.SDK.models.A1099.V2.ErrorModel](docs/A1099/V2/ErrorModel.md) - [Avalara.SDK.models.A1099.V2.ErrorResponse](docs/A1099/V2/ErrorResponse.md) - [Avalara.SDK.models.A1099.V2.ErrorResponseItem](docs/A1099/V2/ErrorResponseItem.md) - [Avalara.SDK.models.A1099.V2.Form1042S](docs/A1099/V2/Form1042S.md) @@ -315,10 +311,10 @@ Class | Method | HTTP request | Description - [Avalara.SDK.models.A1099.V2.Form1099R](docs/A1099/V2/Form1099R.md) - [Avalara.SDK.models.A1099.V2.Form1099StatusDetail](docs/A1099/V2/Form1099StatusDetail.md) - [Avalara.SDK.models.A1099.V2.Get1099Form200Response](docs/A1099/V2/Get1099Form200Response.md) - - [Avalara.SDK.models.A1099.V2.IW9FormDataModelsOneOf](docs/A1099/V2/IW9FormDataModelsOneOf.md) - [Avalara.SDK.models.A1099.V2.IntermediaryOrFlowThrough](docs/A1099/V2/IntermediaryOrFlowThrough.md) - [Avalara.SDK.models.A1099.V2.IrsResponse](docs/A1099/V2/IrsResponse.md) - - [Avalara.SDK.models.A1099.V2.IssuerCommand](docs/A1099/V2/IssuerCommand.md) + - [Avalara.SDK.models.A1099.V2.IssuerBase](docs/A1099/V2/IssuerBase.md) + - [Avalara.SDK.models.A1099.V2.IssuerRequest](docs/A1099/V2/IssuerRequest.md) - [Avalara.SDK.models.A1099.V2.IssuerResponse](docs/A1099/V2/IssuerResponse.md) - [Avalara.SDK.models.A1099.V2.JobResponse](docs/A1099/V2/JobResponse.md) - [Avalara.SDK.models.A1099.V2.OfferAndCoverage](docs/A1099/V2/OfferAndCoverage.md) @@ -333,27 +329,21 @@ Class | Method | HTTP request | Description - [Avalara.SDK.models.A1099.V2.SubstantialUsOwnerResponse](docs/A1099/V2/SubstantialUsOwnerResponse.md) - [Avalara.SDK.models.A1099.V2.TinMatchStatusResponse](docs/A1099/V2/TinMatchStatusResponse.md) - [Avalara.SDK.models.A1099.V2.ValidationError](docs/A1099/V2/ValidationError.md) - - [Avalara.SDK.models.A1099.V2.W4FormDataModel](docs/A1099/V2/W4FormDataModel.md) - [Avalara.SDK.models.A1099.V2.W4FormMinimalRequest](docs/A1099/V2/W4FormMinimalRequest.md) - [Avalara.SDK.models.A1099.V2.W4FormRequest](docs/A1099/V2/W4FormRequest.md) - [Avalara.SDK.models.A1099.V2.W4FormResponse](docs/A1099/V2/W4FormResponse.md) - [Avalara.SDK.models.A1099.V2.W8BenEFormMinimalRequest](docs/A1099/V2/W8BenEFormMinimalRequest.md) - [Avalara.SDK.models.A1099.V2.W8BenEFormRequest](docs/A1099/V2/W8BenEFormRequest.md) - [Avalara.SDK.models.A1099.V2.W8BenEFormResponse](docs/A1099/V2/W8BenEFormResponse.md) - - [Avalara.SDK.models.A1099.V2.W8BenESubstantialUsOwnerDataModel](docs/A1099/V2/W8BenESubstantialUsOwnerDataModel.md) - - [Avalara.SDK.models.A1099.V2.W8BenFormDataModel](docs/A1099/V2/W8BenFormDataModel.md) - [Avalara.SDK.models.A1099.V2.W8BenFormMinimalRequest](docs/A1099/V2/W8BenFormMinimalRequest.md) - [Avalara.SDK.models.A1099.V2.W8BenFormRequest](docs/A1099/V2/W8BenFormRequest.md) - [Avalara.SDK.models.A1099.V2.W8BenFormResponse](docs/A1099/V2/W8BenFormResponse.md) - - [Avalara.SDK.models.A1099.V2.W8BeneFormDataModel](docs/A1099/V2/W8BeneFormDataModel.md) - - [Avalara.SDK.models.A1099.V2.W8ImyFormDataModel](docs/A1099/V2/W8ImyFormDataModel.md) - [Avalara.SDK.models.A1099.V2.W8ImyFormMinimalRequest](docs/A1099/V2/W8ImyFormMinimalRequest.md) - [Avalara.SDK.models.A1099.V2.W8ImyFormRequest](docs/A1099/V2/W8ImyFormRequest.md) - [Avalara.SDK.models.A1099.V2.W8ImyFormResponse](docs/A1099/V2/W8ImyFormResponse.md) - [Avalara.SDK.models.A1099.V2.W9FormBaseMinimalRequest](docs/A1099/V2/W9FormBaseMinimalRequest.md) - [Avalara.SDK.models.A1099.V2.W9FormBaseRequest](docs/A1099/V2/W9FormBaseRequest.md) - [Avalara.SDK.models.A1099.V2.W9FormBaseResponse](docs/A1099/V2/W9FormBaseResponse.md) - - [Avalara.SDK.models.A1099.V2.W9FormDataModel](docs/A1099/V2/W9FormDataModel.md) - [Avalara.SDK.models.A1099.V2.W9FormMinimalRequest](docs/A1099/V2/W9FormMinimalRequest.md) - [Avalara.SDK.models.A1099.V2.W9FormRequest](docs/A1099/V2/W9FormRequest.md) - [Avalara.SDK.models.A1099.V2.W9FormResponse](docs/A1099/V2/W9FormResponse.md) diff --git a/docs/A1099/V2/CompaniesW9Api.md b/docs/A1099/V2/CompaniesW9Api.md index 211cb32..13fe377 100644 --- a/docs/A1099/V2/CompaniesW9Api.md +++ b/docs/A1099/V2/CompaniesW9Api.md @@ -26,9 +26,9 @@ Create a company. import time import Avalara.SDK from Avalara.SDK.api.A1099.V2 import companies_w9_api -CreateCompanyRequest CompanyResponse -ErrorModel +CompanyRequest +ErrorResponse from pprint import pprint # Define configuration object with parameters specified to your application. @@ -45,9 +45,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = companies_w9_api.CompaniesW9Api(api_client) avalara_version = '2.0.0' # str | API version - x_correlation_id = '68cce84c-ae6e-4cef-bdc6-4620c710b5e5' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'a607ad38-398e-43d2-918d-d809e43dbd6b' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - create_company_request = {"name":"Acme Corporation","dbaName":"","email":"contact@acmecorp.com","address":"123 Business Ave","city":"Phoenix","state":"AZ","zip":"85001","telephone":"602-555-0123","tin":"12-3456789","referenceId":"","doTinMatch":null,"groupName":"","foreignProvince":"","countryCode":"US","resendRequests":null,"resendIntervalDays":null,"maxReminderAttempts":null} # CreateCompanyRequest | The company to create (optional) + company_request = {"name":"Acme Corporation","dbaName":"","email":"contact@acmecorp.com","address":"123 Business Ave","city":"Phoenix","state":"AZ","zip":"85001","telephone":"602-555-0123","tin":"12-3456789","referenceId":"","doTinMatch":null,"groupName":"","foreignProvince":"","countryCode":"US","resendRequests":null,"resendIntervalDays":null,"maxReminderAttempts":null} # CompanyRequest | The company to create (optional) # example passing only required values which don't have defaults set try: # Create a company @@ -60,7 +60,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # and optional values try: # Create a company - api_response = api_instance.create_company(avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, create_company_request=create_company_request) + api_response = api_instance.create_company(avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, company_request=company_request) pprint(api_response) except Avalara.SDK.ApiException as e: print("Exception when calling CompaniesW9Api->create_company: %s\n" % e) @@ -73,7 +73,7 @@ Name | Type | Description | Notes **avalara_version** | **str**| API version | **x_correlation_id** | **str**| Unique correlation Id in a GUID format | [optional] **x_avalara_client** | **str**| Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] - **create_company_request** | [**CreateCompanyRequest**](CreateCompanyRequest.md)| The company to create | [optional] + **company_request** | [**CompanyRequest**](CompanyRequest.md)| The company to create | [optional] ### Return type @@ -114,7 +114,7 @@ Delete a company. import time import Avalara.SDK from Avalara.SDK.api.A1099.V2 import companies_w9_api -ErrorModel +ErrorResponse from pprint import pprint # Define configuration object with parameters specified to your application. @@ -132,7 +132,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = companies_w9_api.CompaniesW9Api(api_client) id = 'id_example' # str | The company to delete avalara_version = '2.0.0' # str | API version - x_correlation_id = 'f2e08ea9-6e1e-4828-91f9-4926ff26dbe4' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '54780530-dee1-472f-8626-a1ef1d6f3bfa' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -224,7 +224,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: order_by = 'order_by_example' # str | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. (optional) count = True # bool | If true, return the global count of elements in the collection. (optional) count_only = True # bool | If true, return ONLY the global count of elements in the collection. It only applies when count=true. (optional) - x_correlation_id = 'f431c7bb-9661-447a-8f5f-b17b3d55a06c' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '7ee6e06e-ae28-4317-9053-d966f0b24a94' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -318,7 +318,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = companies_w9_api.CompaniesW9Api(api_client) id = 'id_example' # str | Id of the company avalara_version = '2.0.0' # str | API version - x_correlation_id = 'c5c11797-5ea9-4ec3-85ba-ed4e0ee63300' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'c2254966-bcae-4b32-a7b4-67f0518ca748' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -388,9 +388,9 @@ Update a company. import time import Avalara.SDK from Avalara.SDK.api.A1099.V2 import companies_w9_api -CreateCompanyRequest CompanyResponse -ErrorModel +CompanyRequest +ErrorResponse from pprint import pprint # Define configuration object with parameters specified to your application. @@ -408,9 +408,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = companies_w9_api.CompaniesW9Api(api_client) id = 'id_example' # str | The ID of the company to update avalara_version = '2.0.0' # str | API version - x_correlation_id = '86a26d78-90b6-4ca0-a10b-0221d11dd34a' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'b730ea19-59f4-4cc8-8ef0-94a9d4637a6a' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - create_company_request = {"name":"Acme Corporation","dbaName":"","email":"contact@acmecorp.com","address":"123 Business Ave","city":"Phoenix","state":"AZ","zip":"85001","telephone":"602-555-0123","tin":"12-3456789","referenceId":"","doTinMatch":null,"groupName":"","foreignProvince":"","countryCode":"US","resendRequests":null,"resendIntervalDays":null,"maxReminderAttempts":null} # CreateCompanyRequest | The updated company data (optional) + company_request = {"name":"Acme Corporation","dbaName":"","email":"contact@acmecorp.com","address":"123 Business Ave","city":"Phoenix","state":"AZ","zip":"85001","telephone":"602-555-0123","tin":"12-3456789","referenceId":"","doTinMatch":null,"groupName":"","foreignProvince":"","countryCode":"US","resendRequests":null,"resendIntervalDays":null,"maxReminderAttempts":null} # CompanyRequest | The updated company data (optional) # example passing only required values which don't have defaults set try: # Update a company @@ -423,7 +423,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # and optional values try: # Update a company - api_response = api_instance.update_company(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, create_company_request=create_company_request) + api_response = api_instance.update_company(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, company_request=company_request) pprint(api_response) except Avalara.SDK.ApiException as e: print("Exception when calling CompaniesW9Api->update_company: %s\n" % e) @@ -437,7 +437,7 @@ Name | Type | Description | Notes **avalara_version** | **str**| API version | **x_correlation_id** | **str**| Unique correlation Id in a GUID format | [optional] **x_avalara_client** | **str**| Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] - **create_company_request** | [**CreateCompanyRequest**](CreateCompanyRequest.md)| The updated company data | [optional] + **company_request** | [**CompanyRequest**](CompanyRequest.md)| The updated company data | [optional] ### Return type diff --git a/docs/A1099/V2/CompanyBase.md b/docs/A1099/V2/CompanyBase.md new file mode 100644 index 0000000..215ccf1 --- /dev/null +++ b/docs/A1099/V2/CompanyBase.md @@ -0,0 +1,45 @@ +# CompanyBase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Legal name. Not the DBA name. | +**dba_name** | **str** | Doing Business As (DBA) name or continuation of a long legal name. | [optional] +**email** | **str** | Contact email address. For inquiries by vendors/employees. | +**address** | **str** | Address. | +**city** | **str** | City. | +**state** | **str** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional] +**zip** | **str** | ZIP/postal code. | +**telephone** | **str** | Contact phone number (must contain at least 10 digits, max 15 characters). | +**tin** | **str** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). | +**reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] +**do_tin_match** | **bool** | Indicates whether the company authorizes IRS TIN matching. | [optional] +**group_name** | **str** | Group name for organizing companies (creates or finds group by name). | [optional] +**foreign_province** | **str** | Province or region for non-US/CA addresses. | [optional] +**country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | +**resend_requests** | **bool** | Boolean to enable automatic reminder emails (default: false). | [optional] +**resend_interval_days** | **int** | Days between reminder emails (7-365, required if resendRequests is true). | [optional] +**max_reminder_attempts** | **int** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional] + +## Example + +```python +from Avalara.SDK.models.A1099.V2.company_base import CompanyBase + +# TODO update the JSON string below +json = "{}" +# create an instance of CompanyBase from a JSON string +company_base_instance = CompanyBase.from_json(json) +# print the JSON string representation of the object +print(CompanyBase.to_json()) + +# convert the object into a dict +company_base_dict = company_base_instance.to_dict() +# create an instance of CompanyBase from a dict +company_base_from_dict = CompanyBase.from_dict(company_base_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/A1099/V2/CompanyRequest.md b/docs/A1099/V2/CompanyRequest.md new file mode 100644 index 0000000..3d608b9 --- /dev/null +++ b/docs/A1099/V2/CompanyRequest.md @@ -0,0 +1,45 @@ +# CompanyRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Legal name. Not the DBA name. | +**dba_name** | **str** | Doing Business As (DBA) name or continuation of a long legal name. | [optional] +**email** | **str** | Contact email address. For inquiries by vendors/employees. | +**address** | **str** | Address. | +**city** | **str** | City. | +**state** | **str** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional] +**zip** | **str** | ZIP/postal code. | +**telephone** | **str** | Contact phone number (must contain at least 10 digits, max 15 characters). | +**tin** | **str** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). | +**reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] +**do_tin_match** | **bool** | Indicates whether the company authorizes IRS TIN matching. | [optional] +**group_name** | **str** | Group name for organizing companies (creates or finds group by name). | [optional] +**foreign_province** | **str** | Province or region for non-US/CA addresses. | [optional] +**country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | +**resend_requests** | **bool** | Boolean to enable automatic reminder emails (default: false). | [optional] +**resend_interval_days** | **int** | Days between reminder emails (7-365, required if resendRequests is true). | [optional] +**max_reminder_attempts** | **int** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional] + +## Example + +```python +from Avalara.SDK.models.A1099.V2.company_request import CompanyRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of CompanyRequest from a JSON string +company_request_instance = CompanyRequest.from_json(json) +# print the JSON string representation of the object +print(CompanyRequest.to_json()) + +# convert the object into a dict +company_request_dict = company_request_instance.to_dict() +# create an instance of CompanyRequest from a dict +company_request_from_dict = CompanyRequest.from_dict(company_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/A1099/V2/CreateAndSendW9FormEmailRequest.md b/docs/A1099/V2/CreateAndSendW9FormEmailRequest.md index 7b53702..2c84272 100644 --- a/docs/A1099/V2/CreateAndSendW9FormEmailRequest.md +++ b/docs/A1099/V2/CreateAndSendW9FormEmailRequest.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **employee_first_name** | **str** | The first name of the employee. | **employee_last_name** | **str** | The last name of the employee. | **office_code** | **str** | The office code associated with the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **name** | **str** | The name of the individual or entity associated with the form. | **reference_number** | **str** | A reference number for the form. | [optional] diff --git a/docs/A1099/V2/CreateW9Form201Response.md b/docs/A1099/V2/CreateW9Form201Response.md index bc9a1ff..e130819 100644 --- a/docs/A1099/V2/CreateW9Form201Response.md +++ b/docs/A1099/V2/CreateW9Form201Response.md @@ -5,6 +5,39 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | The form type. | [optional] [readonly] +**employee_first_name** | **str** | The first name of the employee. | [optional] +**employee_middle_name** | **str** | The middle name of the employee. | [optional] +**employee_last_name** | **str** | The last name of the employee. | [optional] +**employee_name_suffix** | **str** | The name suffix of the employee. | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. | [optional] +**tin** | **str** | The taxpayer identification number (TIN). | [optional] +**address** | **str** | The address of the individual or entity. | [optional] +**city** | **str** | The city of the address. | [optional] +**state** | **str** | The state of the address. | [optional] +**zip** | **str** | The ZIP code of the address. | [optional] +**marital_status** | **str** | The marital status of the employee. | [optional] +**last_name_differs** | **bool** | Indicates whether the last name differs from prior records. | [optional] +**num_allowances** | **int** | The number of allowances claimed by the employee. | [optional] +**other_dependents** | **int** | The number of dependents other than allowances. | [optional] +**non_job_income** | **float** | The amount of non-job income. | [optional] +**deductions** | **float** | The amount of deductions claimed. | [optional] +**additional_withheld** | **float** | The additional amount withheld. | [optional] +**exempt_from_withholding** | **bool** | Indicates whether the employee is exempt from withholding. | [optional] +**office_code** | **str** | The office code associated with the form. | [optional] +**id** | **str** | The unique identifier for the form. | [optional] +**entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] +**reference_id** | **str** | A reference identifier for the form. | [optional] +**company_id** | **str** | The ID of the associated company. | [optional] +**display_name** | **str** | The display name associated with the form. | [optional] +**email** | **str** | The email address of the individual associated with the form. | [optional] +**archived** | **bool** | Indicates whether the form is archived. | [optional] +**ancestor_id** | **str** | Form ID of previous version. | [optional] +**signature** | **str** | The signature of the form. | [optional] +**signed_date** | **datetime** | The date the form was signed. | [optional] +**e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] +**created_at** | **datetime** | The creation date of the form. | [optional] +**updated_at** | **datetime** | The last updated date of the form. | [optional] **name** | **str** | The name of the individual or entity associated with the form. | [optional] **citizenship_country** | **str** | The country of citizenship. | [optional] **disregarded_entity** | **str** | The name of the disregarded entity receiving the payment (if applicable). | [optional] @@ -22,8 +55,6 @@ Name | Type | Description | Notes **mailing_state** | **str** | The state of the mailing address. | [optional] **mailing_zip** | **str** | The ZIP code of the mailing address. | [optional] **mailing_country** | **str** | The country of the mailing address. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] -**tin** | **str** | The taxpayer identification number (TIN). | [optional] **giin** | **str** | The global intermediary identification number (GIIN). | [optional] **foreign_tin_not_required** | **bool** | Indicates whether a foreign TIN is not required. | [optional] **foreign_tin** | **str** | The foreign taxpayer identification number (TIN). | [optional] @@ -101,20 +132,6 @@ Name | Type | Description | Notes **substantial_us_owners** | [**List[SubstantialUsOwnerResponse]**](SubstantialUsOwnerResponse.md) | The list of substantial U.S. owners of passive NFFE. | [optional] **signer_name** | **str** | The name of the signer. | [optional] **capacity_to_sign_certification** | **bool** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] -**id** | **str** | The unique identifier for the form. | [optional] -**entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] -**reference_id** | **str** | A reference identifier for the form. | [optional] -**company_id** | **str** | The ID of the associated company. | [optional] -**display_name** | **str** | The display name associated with the form. | [optional] -**email** | **str** | The email address of the individual associated with the form. | [optional] -**archived** | **bool** | Indicates whether the form is archived. | [optional] -**ancestor_id** | **str** | Form ID of previous version. | [optional] -**signature** | **str** | The signature of the form. | [optional] -**signed_date** | **datetime** | The date the form was signed. | [optional] -**e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] -**created_at** | **datetime** | The creation date of the form. | [optional] -**updated_at** | **datetime** | The last updated date of the form. | [optional] -**type** | **str** | The type of the response object. | [optional] **birthday** | **date** | The birthday of the individual associated with the form. | [optional] **signer_capacity** | **str** | The capacity in which the signer is signing the form. | [optional] **qualified_intermediary_certification** | **bool** | Certifies that the entity is a Qualified Intermediary (QI) acting in accordance with its QI Agreement, providing required withholding statements and documentation for relevant tax withholding purposes. | [optional] @@ -163,11 +180,7 @@ Name | Type | Description | Notes **exempt_payee_code** | **str** | The exempt payee code. | [optional] **exempt_fatca_code** | **str** | The exemption from FATCA reporting code. | [optional] **foreign_country_indicator** | **bool** | Indicates whether the individual or entity is in a foreign country. | [optional] -**address** | **str** | The address of the individual or entity. | [optional] **foreign_address** | **str** | The foreign address of the individual or entity. | [optional] -**city** | **str** | The city of the address. | [optional] -**state** | **str** | The state of the address. | [optional] -**zip** | **str** | The ZIP code of the address. | [optional] **account_number** | **str** | The account number associated with the form. | [optional] **backup_withholding** | **bool** | Indicates whether backup withholding applies. | [optional] **is1099able** | **bool** | Indicates whether the individual or entity should be issued a 1099 form. | [optional] diff --git a/docs/A1099/V2/CreateW9FormRequest.md b/docs/A1099/V2/CreateW9FormRequest.md index 4771705..c01f6d2 100644 --- a/docs/A1099/V2/CreateW9FormRequest.md +++ b/docs/A1099/V2/CreateW9FormRequest.md @@ -6,48 +6,48 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | The form type. | [optional] [readonly] -**name** | **str** | The name of the individual or entity associated with the form. | [optional] +**name** | **str** | The name of the individual or entity associated with the form. | **business_name** | **str** | The name of the business associated with the form. | [optional] -**business_classification** | **str** | The classification of the business. | [optional] +**business_classification** | **str** | The classification of the business. Available values: - Individual: Individual/sole proprietor - C Corporation: C Corporation - S Corporation: S Corporation - Partnership: Partnership - Trust/estate: Trust/estate - LLC-C: Limited liability company (C Corporation) - LLC-S: Limited liability company (S Corporation) - LLC-P: Limited liability company (Partnership) - Other: Other (requires BusinessOther field to be populated) | **business_other** | **str** | The classification description when \"businessClassification\" is \"Other\". | [optional] **foreign_partner_owner_or_beneficiary** | **bool** | Indicates whether the individual is a foreign partner, owner, or beneficiary. | [optional] **exempt_payee_code** | **str** | The exempt payee code. | [optional] **exempt_fatca_code** | **str** | The exemption from FATCA reporting code. | [optional] **foreign_country_indicator** | **bool** | Indicates whether the individual or entity is in a foreign country. | [optional] -**address** | **str** | The address of the employee. | [optional] +**address** | **str** | The address of the employee. Required unless exempt. | **foreign_address** | **str** | The foreign address of the individual or entity. | [optional] -**city** | **str** | The city of residence of the employee. | [optional] -**state** | **str** | The state of residence of the employee. | [optional] -**zip** | **str** | The ZIP code of residence of the employee. | [optional] +**city** | **str** | The city of residence of the employee. Required unless exempt. | +**state** | **str** | The state of residence of the employee. Required unless exempt. | +**zip** | **str** | The ZIP code of residence of the employee. Required unless exempt. | **account_number** | **str** | The account number associated with the form. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] -**tin** | **str** | The taxpayer identification number (TIN). | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. | +**tin** | **str** | The taxpayer identification number (TIN). | **backup_withholding** | **bool** | Indicates whether backup withholding applies. | [optional] **is1099able** | **bool** | Indicates whether the individual or entity should be issued a 1099 form. | [optional] **e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] **signature** | **str** | The signature of the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **email** | **str** | The email address of the individual associated with the form. | [optional] -**citizenship_country** | **str** | The country of citizenship. | [optional] +**citizenship_country** | **str** | The country of citizenship. | **disregarded_entity** | **str** | The name of the disregarded entity receiving the payment (if applicable). | [optional] -**entity_type** | **str** | The entity type. | [optional] -**fatca_status** | **str** | The FATCA status. | [optional] +**entity_type** | **str** | The entity type. Available values: - 1: Corporation - 2: Disregarded entity - 3: Partnership - 4: Simple trust - 5: Grantor trust - 6: Complex trust - 7: Estate - 8: Foreign Government - Controlled Entity - 9: Central Bank of Issue - 10: Tax-exempt organization - 11: Private foundation - 12: International organization - 13: Foreign Government - Controlled Integral Part | +**fatca_status** | **str** | The FATCA status. Available values: - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner) - 2: Participating FFI - 3: Reporting Model 1 FFI - 4: Reporting Model 2 FFI - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII) - 6: Sponsored FFI that has not obtained a GIIN - 7: Certified deemed-compliant nonregistering local bank - 8: Certified deemed-compliant FFI with only low-value accounts - 9: Certified deemed-compliant sponsored, closely held investment vehicle - 10: Certified deemed-compliant limited life debt investment entity - 11: Certified deemed-compliant investment advisors and investment managers - 12: Owner-documented FFI - 13: Restricted distributor - 14: Nonreporting IGA FFI - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue - 16: International organization - 17: Exempt retirement plans - 18: Entity wholly owned by exempt beneficial owners - 19: Territory financial institution - 20: Nonfinancial group entity - 21: Excepted nonfinancial start-up company - 22: Excepted nonfinancial entity in liquidation or bankruptcy - 23: 501(c) organization - 24: Nonprofit organization - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation - 26: Excepted territory NFFE - 27: Active NFFE - 28: Passive NFFE - 29: Excepted inter-affiliate FFI - 30: Direct reporting NFFE - 31: Sponsored direct reporting NFFE - 32: Account that is not a financial account | **residence_address** | **str** | The residential address of the individual or entity. | [optional] **residence_city** | **str** | The city of residence. | [optional] **residence_state** | **str** | The state of residence. | [optional] **residence_zip** | **str** | The ZIP code of the residence. | [optional] -**residence_country** | **str** | The country of residence. | [optional] +**residence_country** | **str** | The country of residence. | **residence_is_mailing** | **bool** | Indicates whether the residence address is the mailing address. | [optional] **mailing_address** | **str** | The mailing address. | [optional] **mailing_city** | **str** | The city of the mailing address. | [optional] **mailing_state** | **str** | The state of the mailing address. | [optional] **mailing_zip** | **str** | The ZIP code of the mailing address. | [optional] -**mailing_country** | **str** | The country of the mailing address. | [optional] +**mailing_country** | **str** | The country of the mailing address. | **giin** | **str** | The global intermediary identification number (GIIN). | [optional] **foreign_tin** | **str** | The foreign taxpayer identification number (TIN). | [optional] **reference_number** | **str** | A reference number for the form. | [optional] -**disregarded_entity_fatca_status** | **str** | The FATCA status of disregarded entity or branch receiving payment. | [optional] +**disregarded_entity_fatca_status** | **str** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Limited Branch - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI | [optional] **disregarded_address** | **str** | The address for disregarded entities. | [optional] **disregarded_city** | **str** | The city for disregarded entities. | [optional] **disregarded_state** | **str** | The state for disregarded entities. | [optional] @@ -111,7 +111,7 @@ Name | Type | Description | Notes **foreign_central_bank_of_issue_certification** | **bool** | Certifies that the entity is treated as the beneficial owner of the payment solely for purposes of chapter 4 under Regulations section 1.1471-6(d)(4). | [optional] **nonreporting_iga_ffi_certification** | **bool** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] **iga_country** | **str** | The country for the applicable IGA with the United States. | [optional] -**iga_model** | **str** | The applicable IGA model. | [optional] +**iga_model** | **str** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] **iga_legal_status_treatment** | **str** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] **iga_ffi_trustee_or_sponsor** | **str** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] **iga_ffi_trustee_is_foreign** | **bool** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] @@ -142,7 +142,7 @@ Name | Type | Description | Notes **treaty_country_certification** | **bool** | Certifies the beneficial owner's country under the U.S. tax treaty. | [optional] **treaty_country** | **str** | The country for which the treaty applies. | [optional] **benefit_limitation_certification** | **bool** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional] -**benefit_limitation** | **str** | The benefit limitation for tax treaty claims. | [optional] +**benefit_limitation** | **str** | The benefit limitation for tax treaty claims. Available values: - 1: Government - 2: Tax exempt pension trust or pension fund - 3: Other tax exempt organization - 4: Publicly traded corporation - 5: Subsidiary of a publicly traded corporation - 6: Company that meets the ownership and base erosion test - 7: Company that meets the derivative benefits test - 8: Company with an item of income that meets active trade or business test - 9: Favorable discretionary determination by the U.S. competent authority received - 10: Other | [optional] **qualified_resident_status_certification** | **bool** | Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. | [optional] **treaty_article** | **str** | The specific article of the treaty being claimed. | [optional] **withholding_rate** | **str** | The withholding rate applied as per the treaty. | [optional] @@ -162,11 +162,11 @@ Name | Type | Description | Notes **substantial_us_owners** | [**List[SubstantialUsOwnerRequest]**](SubstantialUsOwnerRequest.md) | The list of substantial U.S. owners of passive NFFE. | [optional] **capacity_to_sign_certification** | **bool** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] **birthday** | **date** | The birthday of the individual associated with the form. | [optional] -**employee_first_name** | **str** | The first name of the employee. | [optional] +**employee_first_name** | **str** | The first name of the employee. | **employee_middle_name** | **str** | The middle name of the employee. | [optional] -**employee_last_name** | **str** | The last name of the employee. | [optional] +**employee_last_name** | **str** | The last name of the employee. | **employee_name_suffix** | **str** | The name suffix of the employee. | [optional] -**marital_status** | **str** | The marital status of the employee. | [optional] +**marital_status** | **str** | The marital status of the employee. Required unless exempt. Available values: - Single: Single or Married filing separately - Married: Married filing jointly or qualifying surviving spouse - MarriedBut: Head of household. Check only if you're unmarried and pay more than half the costs of keeping up a home for yourself and a qualifying individual. | [optional] **last_name_differs** | **bool** | Indicates whether the last name differs from prior records. | [optional] **num_allowances** | **int** | The number of allowances claimed by the employee. | [optional] **other_dependents** | **int** | The number of dependents other than allowances. | [optional] diff --git a/docs/A1099/V2/Form1042S.md b/docs/A1099/V2/Form1042S.md index ca8399a..1c7a2ea 100644 --- a/docs/A1099/V2/Form1042S.md +++ b/docs/A1099/V2/Form1042S.md @@ -6,7 +6,7 @@ Form 1042-S: Foreign Person's U.S. Source Income Subject to Withholding Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tin_type** | **str** | | [optional] [readonly] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] [readonly] **unique_form_id** | **str** | Unique form identifier | **recipient_date_of_birth** | **date** | Recipient's date of birth | [optional] **recipient_giin** | **str** | Recipient's Global Intermediary Identification Number (GIIN). A valid GIIN looks like 'XXXXXX.XXXXX.XX.XXX'. | [optional] @@ -26,16 +26,16 @@ Name | Type | Description | Notes **tax_withheld_other_agents** | **float** | Tax withheld by other agents | [optional] **amount_repaid** | **float** | Amount repaid to recipient | [optional] **tax_paid_agent** | **float** | Tax paid by withholding agent | [optional] -**chap3_status_code** | **str** | Chapter 3 status code - Required if WithholdingIndicator is 3 (Chapter 3) Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary | [optional] -**chap4_status_code** | **str** | Chapter 4 status code. Required if WithholdingIndicator is 4 (Chapter 4). Required if email is specified, must fill either this or RecipientForeignTin. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI | [optional] +**chap3_status_code** | **str** | Chapter 3 status code - Required if WithholdingIndicator is 3 (Chapter 3). Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary | [optional] +**chap4_status_code** | **str** | Chapter 4 status code. Required if WithholdingIndicator is 4 (Chapter 4). Required if email is specified, must fill either this or RecipientForeignTin. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI | [optional] **primary_withholding_agent** | [**PrimaryWithholdingAgent**](PrimaryWithholdingAgent.md) | Primary withholding agent information | [optional] **intermediary_or_flow_through** | [**IntermediaryOrFlowThrough**](IntermediaryOrFlowThrough.md) | Intermediary or flow-through entity information | [optional] -**type** | **str** | Form type | +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | @@ -50,21 +50,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1095B.md b/docs/A1099/V2/Form1095B.md index d988b25..58a9f1d 100644 --- a/docs/A1099/V2/Form1095B.md +++ b/docs/A1099/V2/Form1095B.md @@ -11,18 +11,18 @@ Name | Type | Description | Notes **employee_last_name** | **str** | Employee's last name | **employee_name_suffix** | **str** | Employee's name suffix | [optional] **employee_date_of_birth** | **date** | Employee's date of birth | [optional] -**origin_of_health_coverage_code** | **str** | Origin of health coverage code Available values: - A: Small Business Health Options Program (SHOP) - B: Employer-sponsored coverage - C: Government-sponsored program - D: Individual market insurance - E: Multiemployer plan - F: Other designated minimum essential coverage - G: Employer-sponsored coverage that is an individual coverage HRA (valid for tax years 2020 and later) | +**origin_of_health_coverage_code** | **str** | Origin of health coverage code. Available values: - A: Small Business Health Options Program (SHOP) - B: Employer-sponsored coverage - C: Government-sponsored program - D: Individual market insurance - E: Multiemployer plan - F: Other designated minimum essential coverage - G: Employer-sponsored coverage that is an individual coverage HRA (valid for tax years 2020 and later) | **covered_individuals** | [**List[CoveredIndividual]**](CoveredIndividual.md) | Covered individuals information - At least one month of coverage must be entered if it's not a correction. | [optional] -**type** | **str** | Form type | +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -34,21 +34,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1095C.md b/docs/A1099/V2/Form1095C.md index 56c55f6..5ea77fd 100644 --- a/docs/A1099/V2/Form1095C.md +++ b/docs/A1099/V2/Form1095C.md @@ -15,16 +15,16 @@ Name | Type | Description | Notes **employer_provided_si_coverage** | **bool** | Employer provided self-insured coverage | [optional] **offer_and_coverages** | [**List[OfferAndCoverage]**](OfferAndCoverage.md) | Offer and coverage information | **covered_individuals** | [**List[CoveredIndividual]**](CoveredIndividual.md) | Covered individuals information | [optional] -**type** | **str** | Form type | +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -36,21 +36,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1099Base.md b/docs/A1099/V2/Form1099Base.md index 7a26d92..e1c4b3e 100644 --- a/docs/A1099/V2/Form1099Base.md +++ b/docs/A1099/V2/Form1099Base.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Form type | +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -26,21 +26,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1099Div.md b/docs/A1099/V2/Form1099Div.md index 9aae0ed..a2a0a2b 100644 --- a/docs/A1099/V2/Form1099Div.md +++ b/docs/A1099/V2/Form1099Div.md @@ -1,6 +1,6 @@ # Form1099Div -Form 1099-DIV: Dividends and Distributions +Form 1099-DIV: Dividends and Distributions *At least one of the following dividend or distribution amounts must be provided:* Total ordinary dividends, Total capital gain distributions, Nondividend distributions, Cash liquidation distributions, Noncash liquidation distributions, or Exempt-interest dividends. ## Properties @@ -24,17 +24,17 @@ Name | Type | Description | Notes **noncash_liquidation_distributions** | **float** | Noncash liquidation distributions | [optional] **exempt_interest_dividends** | **float** | Exempt-interest dividends | [optional] **specified_private_activity_bond_interest_dividends** | **float** | Specified private activity bond interest dividends | [optional] -**fatca_filing_requirement** | **bool** | FATCA filing requirement | [optional] -**type** | **str** | Form type | +**fatca_filing_requirement** | **bool** | FATCA filing requirement. | [optional] +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -46,21 +46,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1099Int.md b/docs/A1099/V2/Form1099Int.md index 3b4e4d0..6acd6fc 100644 --- a/docs/A1099/V2/Form1099Int.md +++ b/docs/A1099/V2/Form1099Int.md @@ -1,5 +1,6 @@ # Form1099Int +Form 1099-INT: Interest Imcome *At least one of the following amounts must be provided:* Interest Income, Interest on U.S. Savings Bonds and Treasury obligations, or Tax-Exempt Interest. ## Properties @@ -18,18 +19,18 @@ Name | Type | Description | Notes **bond_premium** | **float** | Bond Premium | [optional] **bond_premium_on_treasury_obligations** | **float** | Bond Premium on Treasury obligations | [optional] **bond_premium_on_tax_exempt_bond** | **float** | Bond Premium on tax exempt bond | [optional] -**tax_exempt_bond_cusip_number** | **str** | Tax exempt bond CUSIP no. | [optional] -**fatca_filing_requirement** | **bool** | FATCA filing requirement | [optional] -**type** | **str** | Form type | +**tax_exempt_bond_cusip_number** | **str** | Tax exempt bond CUSIP no. Enter VARIOUS if the tax-exempt interest is reported in the aggregate for multiple bonds or accounts. | [optional] +**fatca_filing_requirement** | **bool** | FATCA filing requirement. | [optional] +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -41,21 +42,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1099K.md b/docs/A1099/V2/Form1099K.md index 1ce3dd5..653f99f 100644 --- a/docs/A1099/V2/Form1099K.md +++ b/docs/A1099/V2/Form1099K.md @@ -6,13 +6,13 @@ Form 1099-K: Payment Card and Third Party Network Transactions Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**filer_type** | **str** | Filer type (PSE or EPF) | [optional] -**payment_type** | **str** | Payment type (payment card or third party network) | [optional] -**payment_settlement_entity_name_phone_number** | **str** | Payment settlement entity name and phone number | [optional] -**gross_amount_payment_card** | **float** | Gross amount of payment card/third party network transactions | [optional] +**filer_type** | **str** | Filer type for tax reporting purposes. Available values: - PSE: Payment Settlement Entity - EPF: Electronic Payment Facilitator or other third party | +**payment_type** | **str** | Payment type for transaction classification. Available values: - PaymentCard: Payment card transactions - ThirdPartyNetwork: Third party network transactions | +**payment_settlement_entity_name_phone_number** | **str** | Payment settlement entity name and phone number, if different from Filer's | [optional] +**gross_amount_payment_card** | **float** | Gross amount of payment card/third party network transactions. This value must equal the total of all monthly payment amounts (January through December). | **card_not_present_transactions** | **float** | Card not present transactions | [optional] -**merchant_category_code** | **str** | Merchant category code | [optional] -**payment_transaction_number** | **float** | Number of payment transactions | [optional] +**merchant_category_code** | **str** | Merchant category code (4 numbers) | [optional] +**payment_transaction_number** | **float** | Number of payment transactions | **federal_income_tax_withheld** | **float** | Federal income tax withheld | [optional] **january** | **float** | January gross payments | [optional] **february** | **float** | February gross payments | [optional] @@ -26,16 +26,16 @@ Name | Type | Description | Notes **october** | **float** | October gross payments | [optional] **november** | **float** | November gross payments | [optional] **december** | **float** | December gross payments | [optional] -**type** | **str** | Form type | +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -47,21 +47,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1099Misc.md b/docs/A1099/V2/Form1099Misc.md index cdf6826..02bc464 100644 --- a/docs/A1099/V2/Form1099Misc.md +++ b/docs/A1099/V2/Form1099Misc.md @@ -1,6 +1,6 @@ # Form1099Misc -Form 1099-MISC: Miscellaneous Income +Form 1099-MISC: Miscellaneous Income *At least one of the following amounts must be provided:* Rents, Royalties, Other income, Fishing boat proceeds, Medical and health care payments, Substitute payments in lieu of dividends or interest, Crop insurance proceeds, Gross proceeds paid to an attorney, Fish purchased for resale, Section 409A deferrals, Excess golden parachute payments, Nonqualified deferred compensation, Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale ## Properties @@ -20,17 +20,17 @@ Name | Type | Description | Notes **section409_a_deferrals** | **float** | Section 409A deferrals | [optional] **excess_golden_parachute_payments** | **float** | (Legacy field) Excess golden parachute payments | [optional] **nonqualified_deferred_compensation** | **float** | Nonqualified deferred compensation | [optional] -**fatca_filing_requirement** | **bool** | FATCA filing requirement | [optional] -**type** | **str** | Form type | +**fatca_filing_requirement** | **bool** | FATCA filing requirement. | [optional] +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -42,21 +42,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1099Nec.md b/docs/A1099/V2/Form1099Nec.md index da4632c..3a51439 100644 --- a/docs/A1099/V2/Form1099Nec.md +++ b/docs/A1099/V2/Form1099Nec.md @@ -1,23 +1,24 @@ # Form1099Nec +Form 1099-NEC: Nonemployee Compensation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**nonemployee_compensation** | **float** | Nonemployee compensation | -**direct_sales_indicator** | **bool** | Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale | [optional] -**federal_income_tax_withheld** | **float** | Federal income tax withheld | [optional] -**type** | **str** | Form type | +**nonemployee_compensation** | **float** | Nonemployee compensation. Required if DirectSalesIndicator is false. | +**direct_sales_indicator** | **bool** | Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale. Should be true if Nonemployee compensation is not provided. | [optional] +**federal_income_tax_withheld** | **float** | Federal income tax withheld. | [optional] +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -29,21 +30,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Form1099R.md b/docs/A1099/V2/Form1099R.md index 6cc4dc6..2b838ec 100644 --- a/docs/A1099/V2/Form1099R.md +++ b/docs/A1099/V2/Form1099R.md @@ -1,6 +1,6 @@ # Form1099R -Form 1099-R: Distributions From Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc. +Form 1099-R: Distributions From Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc. *At least one of the following amounts must be provided:* Gross distribution, Taxable amount, Capital gain, Employee contributions/Designated Roth contributions or insurance premiums, Net unrealized appreciation in employer's securities, Other amount, Total employee contributions, Traditional IRA/SEP/SIMPLE or Roth conversion amount, or Amount allocable to IRR within 5 years ## Properties @@ -14,8 +14,8 @@ Name | Type | Description | Notes **federal_income_tax_withheld** | **float** | Federal income tax withheld | [optional] **employee_contributions_or_designated_roth_or_insurance_premiums** | **float** | Employee contributions/Designated Roth contributions or insurance premiums | [optional] **net_unrealized_appreciation_in_employer_securities** | **float** | Net unrealized appreciation in employer's securities | [optional] -**distribution_code** | **str** | Distribution code | [optional] -**second_distribution_code** | **str** | Second distribution code | [optional] +**distribution_code** | **str** | Distribution code. Available values: - 1: Early distribution, no known exception (in most cases, under age 59½) - 2: Early distribution, exception applies (under age 59½) - 3: Disability - 4: Death - 5: Prohibited transaction - 6: Section 1035 exchange (a tax-free exchange of life insurance, annuity, qualified long-term care insurance, or endowment contracts) - 7: Normal distribution - 8: Excess contributions plus earnings/excess deferrals (and/or earnings) taxable in payment year - 9: Cost of current life insurance protection (premiums paid by a trustee or custodian for current insurance protection) - A: May be eligible for 10-year tax option - B: Designated Roth account distribution - C: Reportable Death Benefits Under Section 6050Y(c) - D: Annuity payments from nonqualified annuity payments and distributions from life insurance contracts that may be subject to tax under section 1411 - E: Distribution under Employee Plans Compliance Resolution System (EPCRS) - F: Charitable gift annuity - G: Direct rollover and rollover contribution - H: Direct rollover of distribution from a designated Roth account to a Roth IRA - J: Early distribution from a Roth IRA (This code may be used with a Code 8 or P) - K: Distribution of IRA Assets Not Having A Readily Available FMV - L: Loans treated as deemed distributions under section 72(p) - M: Qualified Plan Loan Offsets - N: Recharacterized IRA contribution made for year following payment year - P: Excess contributions plus earnings/excess deferrals taxable for year prior to payment year - Q: Qualified distribution from a Roth IRA (Distribution from a Roth IRA when the 5-year holding period has been met, and the recipient has reached 59½, has died, or is disabled) - R: Recharacterized IRA contribution made for year prior to payment year - S: Early distribution from a SIMPLE IRA in first 2 years no known exceptions - T: Roth IRA distribution exception applies because participant has reached 59½, died or is disabled, but it is unknown if the 5-year period has been met - U: Distribution from ESOP under Section 404(k) - W: Charges or payments for purchasing qualified long-term care insurance contracts under combined arrangements | +**second_distribution_code** | **str** | Second distribution code. Must be a valid combination with the first distribution code. See DistributionCode property documentation for code descriptions. Valid combinations based on first distribution code: - 1: _, 8, B, D, K, L, M, P - 2: _, 8, B, D, K, L, M, P - 3: _, D - 4: _, 8, A, B, D, G, H, K, L, M, P - 5: _ - 6: _, W - 7: _, A, B, D, K, L, M - 8: _, 1, 2, 4, B, J, K - 9: _ - A: 4, 7 - B: _, 1, 2, 4, 7, 8, G, L, M, P, U - C: _, D - D: 1, 2, 3, 4, 7, C - E: _ - F: _ - G: _, 4, B, K - H: _, 4 - J: _, 8, P - K: 1, 2, 4, 7, 8, G - L: _, 1, 2, 4, 7, B - M: _, 1, 2, 4, 7, B - N: _ - P: _, 1, 2, 4, B, J - Q: _ - R: _ - S: _ - T: _ - U: _, B - W: _, 6 (_ indicates no second distribution code) (format: firstDistributionCode: availableSecondDistributionCodes) | [optional] **ira_sep_simple** | **bool** | IRA/SEP/SIMPLE | [optional] **traditional_ira_sep_simple_or_roth_conversion_amount** | **float** | Traditional IRA/SEP/SIMPLE or Roth conversion amount | [optional] **other_amount** | **float** | Other amount | [optional] @@ -25,17 +25,17 @@ Name | Type | Description | Notes **amount_allocable_to_irr_within5_years** | **float** | Amount allocable to IRR within 5 years | [optional] **first_year_of_designated_roth_contribution** | **str** | First year of designated Roth contribution | [optional] **date_of_payment** | **date** | Date of payment | [optional] -**fatca_filing_requirement** | **bool** | FATCA filing requirement | [optional] -**type** | **str** | Form type | +**fatca_filing_requirement** | **bool** | FATCA filing requirement. | [optional] +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **recipient_second_name** | **str** | Recipient second name | [optional] **address** | **str** | Address. | **address2** | **str** | Address line 2. | [optional] @@ -47,21 +47,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] diff --git a/docs/A1099/V2/Forms1099Api.md b/docs/A1099/V2/Forms1099Api.md index 39d0105..178be30 100644 --- a/docs/A1099/V2/Forms1099Api.md +++ b/docs/A1099/V2/Forms1099Api.md @@ -18,7 +18,7 @@ Method | HTTP request | Description Create or update multiple 1099/1095/W2/1042S forms -This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. Maximum of 5000 forms can be processed in a single bulk request. +This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. Maximum of 5000 forms can be processed in a single bulk request. **Date Scheduling Rules:** If federalEfileDate, stateEfileDate, or recipientEdeliveryDate are between current date and beginning of blackout period, scheduled to that date. If dates are in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate. Set dates to null to leave unscheduled. ### Example @@ -48,9 +48,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms1099_api.Forms1099Api(api_client) avalara_version = '2.0.0' # str | API version dry_run = False # bool | defaults to false. If true, it will NOT change the DB. It will just return a report of what would've have been changed in the DB (optional) if omitted the server will use the default value of False - x_correlation_id = '16e56e1f-e623-4f23-9904-21c29b5b4545' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '5ef65de0-c394-4aa2-b249-d8bfcbe9b23a' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - form1099_list_request = {"type":"1099-NEC","forms":[{"type":"1099-NEC","issuerId":"12345","issuerReferenceId":"ISSUER-REF-2024","taxYear":2024,"referenceId":"NEC-REF-001","tin":"123456789","recipientName":"John Doe","tinType":"SSN","recipientSecondName":"Doe Enterprises","address":"123 Main Street","address2":"Suite 100","city":"New York","state":"NY","zip":"10001","email":"john.doe@example.com","accountNumber":"ACC123456","officeCode":"NYC01","countryCode":"US","nonemployeeCompensation":15000.0,"directSalesIndicator":true,"federalIncomeTaxWithheld":3000.0,"secondTinNotice":false,"federalEfileDate":"2024-03-15","stateEfileDate":"2024-03-20","recipientEdeliveryDate":"2024-03-25","postalMail":false,"tinMatch":true,"addressVerification":true,"stateAndLocalWithholding":{"stateTaxWithheld":500.0,"state":"NY","stateIdNumber":"NY123456","stateIncome":15000.0,"localTaxWithheld":250.0,"locality":"New York City","localityIdNumber":"NYC789","localIncome":15000.0}}]} # Form1099ListRequest | (optional) + form1099_list_request = {"type":"1042-S","forms":[{"type":"1042-S","issuerId":"12345","issuerReferenceId":"issuer-001","issuerTin":"94-2765431","taxYear":2024,"referenceId":"1042S-REF-001","tin":"112233445","recipientName":"Michael Jackson","recipientSecondName":"SuperStart","address":"1234 Corporate Blvd","address2":"Suite 500","city":"Anytown","state":"MA","zip":"12345","email":"email@example.com","accountNumber":"ACC01","nonUsProvince":null,"countryCode":"US","federalEfileDate":"2024-03-15","postalMail":true,"stateEfileDate":null,"recipientEdeliveryDate":"2024-03-25","tinMatch":false,"noTin":false,"addressVerification":true,"stateAndLocalWithholding":{"stateTaxWithheld":50,"state":"CA","stateIdNumber":"CA98765432"},"secondTinNotice":true,"uniqueFormId":"1234567890","recipientDateOfBirth":"1990-01-01","recipientGiin":"748291.59302.US.001","recipientForeignTin":"920456.38475.GM.002","lobCode":"06","incomeCode":"16","grossIncome":10000.5,"withholdingIndicator":"3","taxCountryCode":"GM","exemptionCodeChap3":"00","exemptionCodeChap4":"13","taxRateChap3":"30.00","withholdingAllowance":15,"federalTaxWithheld":1500.25,"taxNotDepositedIndicator":true,"academicIndicator":true,"taxWithheldOtherAgents":100,"amountRepaid":200,"taxPaidAgent":50.5,"chap3StatusCode":"06","chap4StatusCode":"02","primaryWithholdingAgent":{"name":"Primary Agent Name","ein":"98-3456789"},"intermediaryOrFlowThrough":{"ein":"98-7654321","chap3StatusCode":"03","chap4StatusCode":"04","name":"Intermediary Name","giin":"748291.59302.US.002","countryCode":"US","foreignTin":"123-45-6789","address":"123 Main St.","city":"Cityville","state":"CA","zip":"98765"}}]} # Form1099ListRequest | (optional) # example passing only required values which don't have defaults set try: # Create or update multiple 1099/1095/W2/1042S forms @@ -110,7 +110,7 @@ Name | Type | Description | Notes Create a 1099/1095/W2/1042S form -Create a 1099/1095/W2/1042S form. +Create a 1099/1095/W2/1042S form. **Date Scheduling Rules:** If federalEfileDate, stateEfileDate, or recipientEdeliveryDate are between current date and beginning of blackout period, scheduled to that date. If dates are in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate. Set dates to null to leave unscheduled. ### Example @@ -138,9 +138,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = forms1099_api.Forms1099Api(api_client) avalara_version = '2.0.0' # str | API version - x_correlation_id = 'e4a7bf40-da9f-452a-b2db-c8b64721610b' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '5b55b569-4e1e-44d3-920c-65153461c426' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - get1099_form200_response = {"type":"1099-NEC","issuerId":"12345","issuerReferenceId":"ISSUER-REF-2024","taxYear":2024,"referenceId":"NEC-REF-001","tin":"123456789","recipientName":"John Doe","tinType":"SSN","recipientSecondName":"Doe Enterprises","address":"123 Main Street","address2":"Suite 100","city":"New York","state":"NY","zip":"10001","email":"john.doe@example.com","accountNumber":"ACC123456","officeCode":"NYC01","countryCode":"US","nonemployeeCompensation":15000.0,"directSalesIndicator":true,"federalIncomeTaxWithheld":3000.0,"secondTinNotice":false,"federalEfileDate":"2024-03-15","stateEfileDate":"2024-03-20","recipientEdeliveryDate":"2024-03-25","postalMail":false,"tinMatch":true,"addressVerification":true,"stateAndLocalWithholding":{"stateTaxWithheld":500.0,"state":"NY","stateIdNumber":"NY123456","stateIncome":15000.0,"localTaxWithheld":250.0,"locality":"New York City","localityIdNumber":"NYC789","localIncome":15000.0}} # Get1099Form200Response | (optional) + get1099_form200_response = {"type":"1042-S","issuerId":"12345","referenceId":"1042S-REF-001","tin":"112233445","recipientName":"Michael Jackson","recipientSecondName":"SuperStart","address":"1234 Corporate Blvd","address2":"Suite 500","city":"Anytown","state":"MA","zip":"12345","email":"email@example.com","accountNumber":"ACC01","nonUsProvince":null,"countryCode":"US","federalEfileDate":"2024-03-15","postalMail":true,"stateEfileDate":null,"recipientEdeliveryDate":"2024-03-25","tinMatch":false,"noTin":false,"addressVerification":true,"stateAndLocalWithholding":{"stateTaxWithheld":50,"state":"CA","stateIdNumber":"CA98765432"},"secondTinNotice":true,"uniqueFormId":"1234567890","recipientDateOfBirth":"1990-01-01","recipientGiin":"748291.59302.US.001","recipientForeignTin":"920456.38475.GM.002","lobCode":"06","incomeCode":"16","grossIncome":10000.5,"withholdingIndicator":"3","taxCountryCode":"GM","exemptionCodeChap3":"00","exemptionCodeChap4":"13","taxRateChap3":"30.00","withholdingAllowance":15,"federalTaxWithheld":1500.25,"taxNotDepositedIndicator":true,"academicIndicator":true,"taxWithheldOtherAgents":100,"amountRepaid":200,"taxPaidAgent":50.5,"chap3StatusCode":"06","chap4StatusCode":"02","primaryWithholdingAgent":{"name":"Primary Agent Name","ein":"98-3456789"},"intermediaryOrFlowThrough":{"ein":"98-7654321","chap3StatusCode":"03","chap4StatusCode":"04","name":"Intermediary Name","giin":"748291.59302.US.002","countryCode":"US","foreignTin":"123-45-6789","address":"123 Main St.","city":"Cityville","state":"CA","zip":"98765"}} # Get1099Form200Response | (optional) # example passing only required values which don't have defaults set try: # Create a 1099/1095/W2/1042S form @@ -226,7 +226,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms1099_api.Forms1099Api(api_client) id = 'id_example' # str | The unique identifier of the desired form to delete. avalara_version = '2.0.0' # str | API version - x_correlation_id = '8e01e950-8e1c-4b1b-9120-2e2452c6d590' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'e82ee14f-7146-41a5-b856-28f403d65e29' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -314,7 +314,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms1099_api.Forms1099Api(api_client) id = 'id_example' # str | avalara_version = '2.0.0' # str | API version - x_correlation_id = '7b8174a3-a873-4a05-a619-f362955f4608' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'f5198e72-fc87-4a4d-a09a-b2aa6cf70c38' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -403,7 +403,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: id = 'id_example' # str | The ID of the form avalara_version = '2.0.0' # str | API version mark_edelivered = True # bool | Optional boolean that if set indicates that the form should be marked as having been successfully edelivered (optional) - x_correlation_id = 'a4dd3a23-ae45-45a5-8612-75e2fe4c1f36' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '7fdfd0b2-cebf-4f25-8a65-6dd03811e77d' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -498,7 +498,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: order_by = 'order_by_example' # str | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. (optional) count = True # bool | If true, return the global count of elements in the collection. (optional) count_only = True # bool | If true, return ONLY the global count of elements in the collection. It only applies when count=true. (optional) - x_correlation_id = 'f808e46a-fc55-4dd7-960d-13c6ba8176f2' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '97f7596c-99c0-4879-b47c-57df572a32c9' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -563,7 +563,7 @@ Name | Type | Description | Notes Update a 1099/1095/W2/1042S form -Update a 1099/1095/W2/1042S form. +Update a 1099/1095/W2/1042S form. **Date Update Rules:** Possible to update scheduled dates (same validation rules apply). Cannot change from scheduled to unscheduled status - must delete form and create new one. If dates are between current date and blackout period, scheduled to that date. If dates are in past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate. ### Example @@ -592,9 +592,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms1099_api.Forms1099Api(api_client) id = 'id_example' # str | avalara_version = '2.0.0' # str | API version - x_correlation_id = '944ee583-b810-471c-852c-d3c6f8b93a4b' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '560aa857-d5ba-484b-9375-a14e9e57d7a8' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - get1099_form200_response = {"type":"1099-NEC","issuerId":"12345","issuerReferenceId":"ISSUER-REF-2024","taxYear":2024,"referenceId":"NEC-REF-001","tin":"123456789","recipientName":"John Doe","tinType":"SSN","recipientSecondName":"Doe Enterprises","address":"123 Main Street","address2":"Suite 100","city":"New York","state":"NY","zip":"10001","email":"john.doe@example.com","accountNumber":"ACC123456","officeCode":"NYC01","countryCode":"US","nonemployeeCompensation":15000.0,"directSalesIndicator":true,"federalIncomeTaxWithheld":3000.0,"secondTinNotice":false,"federalEfileDate":"2024-03-15","stateEfileDate":"2024-03-20","recipientEdeliveryDate":"2024-03-25","postalMail":false,"tinMatch":true,"addressVerification":true,"stateAndLocalWithholding":{"stateTaxWithheld":500.0,"state":"NY","stateIdNumber":"NY123456","stateIncome":15000.0,"localTaxWithheld":250.0,"locality":"New York City","localityIdNumber":"NYC789","localIncome":15000.0}} # Get1099Form200Response | (optional) + get1099_form200_response = {"type":"1042-S","issuerId":"12345","referenceId":"1042S-REF-001","tin":"112233445","recipientName":"Michael Jackson","recipientSecondName":"SuperStart","address":"1234 Corporate Blvd","address2":"Suite 500","city":"Anytown","state":"MA","zip":"12345","email":"email@example.com","accountNumber":"ACC01","nonUsProvince":null,"countryCode":"US","federalEfileDate":"2024-03-15","postalMail":true,"stateEfileDate":null,"recipientEdeliveryDate":"2024-03-25","tinMatch":false,"noTin":false,"addressVerification":true,"stateAndLocalWithholding":{"stateTaxWithheld":50,"state":"CA","stateIdNumber":"CA98765432"},"secondTinNotice":true,"uniqueFormId":"1234567890","recipientDateOfBirth":"1990-01-01","recipientGiin":"748291.59302.US.001","recipientForeignTin":"920456.38475.GM.002","lobCode":"06","incomeCode":"16","grossIncome":10000.5,"withholdingIndicator":"3","taxCountryCode":"GM","exemptionCodeChap3":"00","exemptionCodeChap4":"13","taxRateChap3":"30.00","withholdingAllowance":15,"federalTaxWithheld":1500.25,"taxNotDepositedIndicator":true,"academicIndicator":true,"taxWithheldOtherAgents":100,"amountRepaid":200,"taxPaidAgent":50.5,"chap3StatusCode":"06","chap4StatusCode":"02","primaryWithholdingAgent":{"name":"Primary Agent Name","ein":"98-3456789"},"intermediaryOrFlowThrough":{"ein":"98-7654321","chap3StatusCode":"03","chap4StatusCode":"04","name":"Intermediary Name","giin":"748291.59302.US.002","countryCode":"US","foreignTin":"123-45-6789","address":"123 Main St.","city":"Cityville","state":"CA","zip":"98765"}} # Get1099Form200Response | (optional) # example passing only required values which don't have defaults set try: # Update a 1099/1095/W2/1042S form diff --git a/docs/A1099/V2/FormsW9Api.md b/docs/A1099/V2/FormsW9Api.md index 63af8f7..06bd4d7 100644 --- a/docs/A1099/V2/FormsW9Api.md +++ b/docs/A1099/V2/FormsW9Api.md @@ -48,9 +48,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = forms_w9_api.FormsW9Api(api_client) avalara_version = '2.0.0' # str | API version - x_correlation_id = '876394c1-80f7-4f02-a857-3899965a96bf' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '96f3173e-05e5-496d-b7a2-8f3c8711164f' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - create_and_send_w9_form_email_request = {"type":"W9","email":"john.doe@example.com","name":"John Doe","accountNumber":"ACC01","companyId":"32553266","referenceId":"REF-12345"} # CreateAndSendW9FormEmailRequest | Form to be created (optional) + create_and_send_w9_form_email_request = {"type":"W9","email":"john.doe@example.com","name":"John Doe","accountNumber":"ACC01","companyId":"12345","referenceId":"REF-12345"} # CreateAndSendW9FormEmailRequest | Form to be created (optional) # example passing only required values which don't have defaults set try: # Create a minimal W9/W4/W8 form and sends the e-mail request @@ -136,9 +136,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = forms_w9_api.FormsW9Api(api_client) avalara_version = '2.0.0' # str | API version - x_correlation_id = '4f7d2a74-9904-4300-b8c4-d5eadabea39b' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '4fef31cf-2985-471b-83bb-59b4bf4cee0e' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - create_w9_form_request = {"type":"W9","name":"John Doe","businessName":"Acme Inc.","businessClassification":"Individual","businessOther":null,"foreignPartnerOwnerOrBeneficiary":false,"exemptPayeeCode":null,"exemptFatcaCode":null,"foreignCountryIndicator":false,"address":"123 Main St.","foreignAddress":null,"city":"Anytown","state":"CA","zip":"12345","accountNumber":null,"tinType":"SSN","tin":"543456789","backupWithholding":false,"is1099able":true,"eDeliveryConsentedAt":null,"signature":null,"companyId":"32553266","referenceId":null,"email":null} # CreateW9FormRequest | Form to be created (optional) + create_w9_form_request = {"type":"W9","name":"John Doe","businessName":"Acme Inc.","businessClassification":"Individual","businessOther":null,"foreignPartnerOwnerOrBeneficiary":false,"exemptPayeeCode":"5","exemptFatcaCode":"A","foreignCountryIndicator":false,"address":"123 Main St.","foreignAddress":null,"city":"Anytown","state":"CA","zip":"12345","accountNumber":"ACC123456","tinType":"SSN","tin":"543456789","backupWithholding":false,"is1099able":true,"eDeliveryConsentedAt":"2024-05-01T10:30:10.000000","signature":null,"companyId":"32553266","referenceId":"REF12345","email":"johndoe@example.com"} # CreateW9FormRequest | Form to be created (optional) # example passing only required values which don't have defaults set try: # Create a W9/W4/W8 form @@ -185,7 +185,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | The created W9/W4/W8 form | - | -**400** | Bad request (e.g., invalid sort key) | - | +**400** | Bad request (e.g., missing required field) | - | **401** | Authentication failed | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -205,7 +205,7 @@ Delete a W9/W4/W8 form. import time import Avalara.SDK from Avalara.SDK.api.A1099.V2 import forms_w9_api -ErrorModel +ErrorResponse from pprint import pprint # Define configuration object with parameters specified to your application. @@ -223,7 +223,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms_w9_api.FormsW9Api(api_client) id = 'id_example' # str | ID of the form to delete avalara_version = '2.0.0' # str | API version - x_correlation_id = '897b8ec0-bd1d-404b-b128-05268ad1823d' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'b1cd71dd-2fd3-483d-b611-0dd8306b5201' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -269,8 +269,8 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Empty response | - | -**400** | Bad request (e.g., invalid sort key) | - | **401** | Authentication failed | - | +**404** | W9/W4/W8 form not found | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -308,7 +308,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms_w9_api.FormsW9Api(api_client) id = 'id_example' # str | ID of the form avalara_version = '2.0.0' # str | API version - x_correlation_id = '5aacb16c-2a0a-4896-a0d2-a121f2b5d1d8' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '6d803604-fec0-4f42-9114-e77ddd25d823' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -377,7 +377,7 @@ import time import Avalara.SDK from Avalara.SDK.api.A1099.V2 import forms_w9_api PaginatedQueryResultModelW9FormBaseResponse -ErrorModel +ErrorResponse from pprint import pprint # Define configuration object with parameters specified to your application. @@ -400,7 +400,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: order_by = 'order_by_example' # str | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. (optional) count = True # bool | If true, return the global count of elements in the collection. (optional) count_only = True # bool | If true, return ONLY the global count of elements in the collection. It only applies when count=true. (optional) - x_correlation_id = '779b71e3-fc48-49be-b680-e44e47b3d963' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '5473c6dd-8986-4b62-b027-9a94c94f9401' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -452,9 +452,9 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| +**200** | list | - | **400** | Bad request (e.g., invalid sort key) | - | **401** | Authentication failed | - | -**200** | list | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -463,7 +463,7 @@ Name | Type | Description | Notes Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form -Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request. +Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request. ### Example @@ -492,7 +492,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms_w9_api.FormsW9Api(api_client) id = 'id_example' # str | The ID of the W9/W4/W8 form. avalara_version = '2.0.0' # str | API version - x_correlation_id = '8f5afdc6-9616-494f-940c-c66b87b43d27' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '1204a47d-7c4d-4b63-8776-560f89e236e6' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -541,13 +541,14 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Email sent using existing form (form was already in 'Requested' status or descendant found) | - | **201** | Email sent using newly created minimal form | - | -**400** | Bad request (e.g., invalid sort key) | - | +**400** | Bad request (e.g., missing vendor e-mail) | - | **401** | Authentication failed | - | +**404** | W9/W4/W8 form not found | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) # **update_w9_form** -> IW9FormDataModelsOneOf update_w9_form(id, avalara_version) +> CreateW9Form201Response update_w9_form(id, avalara_version) Update a W9/W4/W8 form @@ -561,7 +562,8 @@ Update a W9/W4/W8 form. import time import Avalara.SDK from Avalara.SDK.api.A1099.V2 import forms_w9_api -IW9FormDataModelsOneOf +CreateW9FormRequest +CreateW9Form201Response ErrorResponse from pprint import pprint @@ -580,9 +582,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms_w9_api.FormsW9Api(api_client) id = 'id_example' # str | ID of the form to update avalara_version = '2.0.0' # str | API version - x_correlation_id = 'e0842c54-95c7-488a-882a-ce34cb46e87d' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '2f240777-dd4f-4aaf-b4b6-fcb22df6de90' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - iw9_form_data_models_one_of = Avalara.SDK.IW9FormDataModelsOneOf() # IW9FormDataModelsOneOf | Form to be updated (optional) + create_w9_form_request = {"type":"W9","name":"John Doe","businessName":"Acme Inc.","businessClassification":"Individual","businessOther":null,"foreignPartnerOwnerOrBeneficiary":false,"exemptPayeeCode":"5","exemptFatcaCode":"A","foreignCountryIndicator":false,"address":"123 Main St.","foreignAddress":null,"city":"Anytown","state":"CA","zip":"12345","accountNumber":"ACC123456","tinType":"SSN","tin":"543456789","backupWithholding":false,"is1099able":true,"eDeliveryConsentedAt":"2024-05-01T10:30:10.000000","signature":null,"referenceId":"REF12345","email":"johndoe@example.com"} # CreateW9FormRequest | Form to be updated (optional) # example passing only required values which don't have defaults set try: # Update a W9/W4/W8 form @@ -595,7 +597,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # and optional values try: # Update a W9/W4/W8 form - api_response = api_instance.update_w9_form(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, iw9_form_data_models_one_of=iw9_form_data_models_one_of) + api_response = api_instance.update_w9_form(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, create_w9_form_request=create_w9_form_request) pprint(api_response) except Avalara.SDK.ApiException as e: print("Exception when calling FormsW9Api->update_w9_form: %s\n" % e) @@ -609,11 +611,11 @@ Name | Type | Description | Notes **avalara_version** | **str**| API version | **x_correlation_id** | **str**| Unique correlation Id in a GUID format | [optional] **x_avalara_client** | **str**| Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] - **iw9_form_data_models_one_of** | [**IW9FormDataModelsOneOf**](IW9FormDataModelsOneOf.md)| Form to be updated | [optional] + **create_w9_form_request** | [**CreateW9FormRequest**](CreateW9FormRequest.md)| Form to be updated | [optional] ### Return type -[**IW9FormDataModelsOneOf**](IW9FormDataModelsOneOf.md) +[**CreateW9Form201Response**](CreateW9Form201Response.md) ### Authorization @@ -630,7 +632,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | The updated W9/W4/W8 form | - | -**400** | Bad request (e.g., invalid sort key) | - | +**400** | Bad request (e.g., missing required field) | - | **401** | Authentication failed | - | **404** | W9/W4/W8 form not found | - | @@ -669,7 +671,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = forms_w9_api.FormsW9Api(api_client) id = 'id_example' # str | Id of the form avalara_version = '2.0.0' # str | API version - x_correlation_id = 'ba11f0c0-e9ed-4667-8137-0026b63b63cf' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'ba65d92c-2a2a-4b4e-9731-c7b385d7fb59' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) file = None # bytearray | (optional) # example passing only required values which don't have defaults set @@ -717,9 +719,9 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | -**400** | Bad request (e.g., Only .pdf files are allowed.) | - | +**400** | Bad request (e.g., only .pdf files are allowed.) | - | **401** | Authentication failed | - | -**404** | Not Found | - | +**404** | W9/W4/W8 form not found | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) diff --git a/docs/A1099/V2/Get1099Form200Response.md b/docs/A1099/V2/Get1099Form200Response.md index c5edbe1..94f7c68 100644 --- a/docs/A1099/V2/Get1099Form200Response.md +++ b/docs/A1099/V2/Get1099Form200Response.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tin_type** | **str** | Type of TIN (Tax ID Number) | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number | [optional] **unique_form_id** | **str** | Unique form identifier | **recipient_date_of_birth** | **date** | Recipient's date of birth | [optional] **recipient_giin** | **str** | Recipient's Global Intermediary Identification Number (GIIN). A valid GIIN looks like 'XXXXXX.XXXXX.XX.XXX'. | [optional] @@ -25,16 +25,16 @@ Name | Type | Description | Notes **tax_withheld_other_agents** | **float** | Tax withheld by other agents | [optional] **amount_repaid** | **float** | Amount repaid to recipient | [optional] **tax_paid_agent** | **float** | Tax paid by withholding agent | [optional] -**chap3_status_code** | **str** | Chapter 3 status code - Required if WithholdingIndicator is 3 (Chapter 3) Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary | [optional] -**chap4_status_code** | **str** | Chapter 4 status code. Required if WithholdingIndicator is 4 (Chapter 4). Required if email is specified, must fill either this or RecipientForeignTin. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI | [optional] +**chap3_status_code** | **str** | Chapter 3 status code - Required if WithholdingIndicator is 3 (Chapter 3). Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary | [optional] +**chap4_status_code** | **str** | Chapter 4 status code. Required if WithholdingIndicator is 4 (Chapter 4). Required if email is specified, must fill either this or RecipientForeignTin. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI | [optional] **primary_withholding_agent** | [**PrimaryWithholdingAgent**](PrimaryWithholdingAgent.md) | Primary withholding agent information | [optional] **intermediary_or_flow_through** | [**IntermediaryOrFlowThrough**](IntermediaryOrFlowThrough.md) | Intermediary or flow-through entity information | [optional] -**type** | **str** | Form type | +**type** | **str** | Form type. | **id** | **str** | Form ID. Unique identifier set when the record is created. | [optional] [readonly] **issuer_id** | **str** | Issuer ID - only required when creating forms | [optional] -**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms | [optional] +**issuer_reference_id** | **str** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] **issuer_tin** | **str** | Issuer TIN - readonly | [optional] -**tax_year** | **int** | Tax Year - only required when creating forms | [optional] +**tax_year** | **int** | Tax Year - only required when creating forms via $bulk-upsert | [optional] **reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. | [optional] **tin** | **str** | Recipient's Federal Tax Identification Number (TIN). | [optional] **recipient_name** | **str** | Recipient name | @@ -49,21 +49,21 @@ Name | Type | Description | Notes **office_code** | **str** | Office code | [optional] **non_us_province** | **str** | Province or region for non-US/CA addresses. | [optional] **country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | -**federal_efile_date** | **date** | Date when federal e-filing should be scheduled for this form | [optional] +**federal_efile_date** | **date** | Date when federal e-filing should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **postal_mail** | **bool** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] -**state_efile_date** | **date** | Date when state e-filing should be scheduled for this form | [optional] -**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled for this form | [optional] +**state_efile_date** | **date** | Date when state e-filing should be scheduled. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] +**recipient_edelivery_date** | **date** | Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled. | [optional] **tin_match** | **bool** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] **no_tin** | **bool** | No TIN indicator | [optional] **address_verification** | **bool** | Boolean indicating that address verification should be scheduled for this form | [optional] **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] **second_tin_notice** | **bool** | Second TIN notice | [optional] -**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional] [readonly] -**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status | [optional] [readonly] -**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional] [readonly] -**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional] [readonly] -**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional] [readonly] -**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional] [readonly] +**federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states) | [optional] [readonly] +**state_efile_status** | [**List[StateEfileStatusDetail]**](StateEfileStatusDetail.md) | State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state | [optional] [readonly] +**postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered | [optional] [readonly] +**tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued | [optional] [readonly] +**address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted | [optional] [readonly] +**e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend) | [optional] [readonly] **validation_errors** | [**List[ValidationError]**](ValidationError.md) | Validation errors | [optional] [readonly] **created_at** | **datetime** | Date time when the record was created. | [optional] [readonly] **updated_at** | **datetime** | Date time when the record was last updated. | [optional] [readonly] @@ -72,7 +72,7 @@ Name | Type | Description | Notes **employee_last_name** | **str** | Employee's last name | **employee_name_suffix** | **str** | Employee's name suffix | [optional] **employee_date_of_birth** | **date** | Employee's date of birth | [optional] -**origin_of_health_coverage_code** | **str** | Origin of health coverage code Available values: - A: Small Business Health Options Program (SHOP) - B: Employer-sponsored coverage - C: Government-sponsored program - D: Individual market insurance - E: Multiemployer plan - F: Other designated minimum essential coverage - G: Employer-sponsored coverage that is an individual coverage HRA (valid for tax years 2020 and later) | +**origin_of_health_coverage_code** | **str** | Origin of health coverage code. Available values: - A: Small Business Health Options Program (SHOP) - B: Employer-sponsored coverage - C: Government-sponsored program - D: Individual market insurance - E: Multiemployer plan - F: Other designated minimum essential coverage - G: Employer-sponsored coverage that is an individual coverage HRA (valid for tax years 2020 and later) | **covered_individuals** | [**List[CoveredIndividual]**](CoveredIndividual.md) | Covered individuals information | [optional] **plan_start_month** | **str** | Plan start month. The calendar month during which the plan year begins of the health plan in which the employee is offered coverage (or would be offered coverage if the employee were eligible to participate in the plan). Available values: - 00: None - 01: January - 02: February - 03: March - 04: April - 05: May - 06: June - 07: July - 08: August - 09: September - 10: October - 11: November - 12: December | **employer_provided_si_coverage** | **bool** | Employer provided self-insured coverage | [optional] @@ -95,7 +95,7 @@ Name | Type | Description | Notes **noncash_liquidation_distributions** | **float** | Noncash liquidation distributions | [optional] **exempt_interest_dividends** | **float** | Exempt-interest dividends | [optional] **specified_private_activity_bond_interest_dividends** | **float** | Specified private activity bond interest dividends | [optional] -**fatca_filing_requirement** | **bool** | FATCA filing requirement | [optional] +**fatca_filing_requirement** | **bool** | FATCA filing requirement. | [optional] **interest_income** | **float** | Interest Income | [optional] **early_withdrawal_penalty** | **float** | Early Withdrawal Penalty | [optional] **us_savings_bonds_interest** | **float** | Interest on U.S. Savings Bonds and Treasury obligations | [optional] @@ -106,14 +106,14 @@ Name | Type | Description | Notes **bond_premium** | **float** | Bond Premium | [optional] **bond_premium_on_treasury_obligations** | **float** | Bond Premium on Treasury obligations | [optional] **bond_premium_on_tax_exempt_bond** | **float** | Bond Premium on tax exempt bond | [optional] -**tax_exempt_bond_cusip_number** | **str** | Tax exempt bond CUSIP no. | [optional] -**filer_type** | **str** | Filer type (PSE or EPF) | [optional] -**payment_type** | **str** | Payment type (payment card or third party network) | [optional] -**payment_settlement_entity_name_phone_number** | **str** | Payment settlement entity name and phone number | [optional] -**gross_amount_payment_card** | **float** | Gross amount of payment card/third party network transactions | [optional] +**tax_exempt_bond_cusip_number** | **str** | Tax exempt bond CUSIP no. Enter VARIOUS if the tax-exempt interest is reported in the aggregate for multiple bonds or accounts. | [optional] +**filer_type** | **str** | Filer type for tax reporting purposes. Available values: - PSE: Payment Settlement Entity - EPF: Electronic Payment Facilitator or other third party | +**payment_type** | **str** | Payment type for transaction classification. Available values: - PaymentCard: Payment card transactions - ThirdPartyNetwork: Third party network transactions | +**payment_settlement_entity_name_phone_number** | **str** | Payment settlement entity name and phone number, if different from Filer's | [optional] +**gross_amount_payment_card** | **float** | Gross amount of payment card/third party network transactions. This value must equal the total of all monthly payment amounts (January through December). | **card_not_present_transactions** | **float** | Card not present transactions | [optional] -**merchant_category_code** | **str** | Merchant category code | [optional] -**payment_transaction_number** | **float** | Number of payment transactions | [optional] +**merchant_category_code** | **str** | Merchant category code (4 numbers) | [optional] +**payment_transaction_number** | **float** | Number of payment transactions | **january** | **float** | January gross payments | [optional] **february** | **float** | February gross payments | [optional] **march** | **float** | March gross payments | [optional] @@ -131,7 +131,7 @@ Name | Type | Description | Notes **other_income** | **float** | Other income | [optional] **fishing_boat_proceeds** | **float** | Fishing boat proceeds | [optional] **medical_and_health_care_payments** | **float** | Medical and health care payments | [optional] -**direct_sales_indicator** | **bool** | Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale | [optional] +**direct_sales_indicator** | **bool** | Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale. Should be true if Nonemployee compensation is not provided. | [optional] **substitute_payments** | **float** | Substitute payments in lieu of dividends or interest | [optional] **crop_insurance_proceeds** | **float** | Crop insurance proceeds | [optional] **gross_proceeds_paid_to_attorney** | **float** | Gross proceeds paid to an attorney | [optional] @@ -139,7 +139,7 @@ Name | Type | Description | Notes **section409_a_deferrals** | **float** | Section 409A deferrals | [optional] **excess_golden_parachute_payments** | **float** | (Legacy field) Excess golden parachute payments | [optional] **nonqualified_deferred_compensation** | **float** | Nonqualified deferred compensation | [optional] -**nonemployee_compensation** | **float** | Nonemployee compensation | +**nonemployee_compensation** | **float** | Nonemployee compensation. Required if DirectSalesIndicator is false. | **gross_distribution** | **float** | Gross distribution | [optional] **taxable_amount** | **float** | Taxable amount | [optional] **taxable_amount_not_determined** | **bool** | Taxable amount not determined | [optional] @@ -147,8 +147,8 @@ Name | Type | Description | Notes **capital_gain** | **float** | Capital gain (included in Box 2a) | [optional] **employee_contributions_or_designated_roth_or_insurance_premiums** | **float** | Employee contributions/Designated Roth contributions or insurance premiums | [optional] **net_unrealized_appreciation_in_employer_securities** | **float** | Net unrealized appreciation in employer's securities | [optional] -**distribution_code** | **str** | Distribution code | [optional] -**second_distribution_code** | **str** | Second distribution code | [optional] +**distribution_code** | **str** | Distribution code. Available values: - 1: Early distribution, no known exception (in most cases, under age 59½) - 2: Early distribution, exception applies (under age 59½) - 3: Disability - 4: Death - 5: Prohibited transaction - 6: Section 1035 exchange (a tax-free exchange of life insurance, annuity, qualified long-term care insurance, or endowment contracts) - 7: Normal distribution - 8: Excess contributions plus earnings/excess deferrals (and/or earnings) taxable in payment year - 9: Cost of current life insurance protection (premiums paid by a trustee or custodian for current insurance protection) - A: May be eligible for 10-year tax option - B: Designated Roth account distribution - C: Reportable Death Benefits Under Section 6050Y(c) - D: Annuity payments from nonqualified annuity payments and distributions from life insurance contracts that may be subject to tax under section 1411 - E: Distribution under Employee Plans Compliance Resolution System (EPCRS) - F: Charitable gift annuity - G: Direct rollover and rollover contribution - H: Direct rollover of distribution from a designated Roth account to a Roth IRA - J: Early distribution from a Roth IRA (This code may be used with a Code 8 or P) - K: Distribution of IRA Assets Not Having A Readily Available FMV - L: Loans treated as deemed distributions under section 72(p) - M: Qualified Plan Loan Offsets - N: Recharacterized IRA contribution made for year following payment year - P: Excess contributions plus earnings/excess deferrals taxable for year prior to payment year - Q: Qualified distribution from a Roth IRA (Distribution from a Roth IRA when the 5-year holding period has been met, and the recipient has reached 59½, has died, or is disabled) - R: Recharacterized IRA contribution made for year prior to payment year - S: Early distribution from a SIMPLE IRA in first 2 years no known exceptions - T: Roth IRA distribution exception applies because participant has reached 59½, died or is disabled, but it is unknown if the 5-year period has been met - U: Distribution from ESOP under Section 404(k) - W: Charges or payments for purchasing qualified long-term care insurance contracts under combined arrangements | +**second_distribution_code** | **str** | Second distribution code. Must be a valid combination with the first distribution code. See DistributionCode property documentation for code descriptions. Valid combinations based on first distribution code: - 1: _, 8, B, D, K, L, M, P - 2: _, 8, B, D, K, L, M, P - 3: _, D - 4: _, 8, A, B, D, G, H, K, L, M, P - 5: _ - 6: _, W - 7: _, A, B, D, K, L, M - 8: _, 1, 2, 4, B, J, K - 9: _ - A: 4, 7 - B: _, 1, 2, 4, 7, 8, G, L, M, P, U - C: _, D - D: 1, 2, 3, 4, 7, C - E: _ - F: _ - G: _, 4, B, K - H: _, 4 - J: _, 8, P - K: 1, 2, 4, 7, 8, G - L: _, 1, 2, 4, 7, B - M: _, 1, 2, 4, 7, B - N: _ - P: _, 1, 2, 4, B, J - Q: _ - R: _ - S: _ - T: _ - U: _, B - W: _, 6 (_ indicates no second distribution code) (format: firstDistributionCode: availableSecondDistributionCodes) | [optional] **ira_sep_simple** | **bool** | IRA/SEP/SIMPLE | [optional] **traditional_ira_sep_simple_or_roth_conversion_amount** | **float** | Traditional IRA/SEP/SIMPLE or Roth conversion amount | [optional] **other_amount** | **float** | Other amount | [optional] diff --git a/docs/A1099/V2/IntermediaryOrFlowThrough.md b/docs/A1099/V2/IntermediaryOrFlowThrough.md index 2c3db9d..da2b09c 100644 --- a/docs/A1099/V2/IntermediaryOrFlowThrough.md +++ b/docs/A1099/V2/IntermediaryOrFlowThrough.md @@ -7,8 +7,8 @@ Intermediary or flow-through entity information for tax forms Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ein** | **str** | EIN (Employer Identification Number) of the intermediary or flow-through entity | [optional] -**chap3_status_code** | **str** | Chapter 3 status code for the intermediary or flow-through entity | [optional] -**chap4_status_code** | **str** | Chapter 4 status code for the intermediary or flow-through entity | [optional] +**chap3_status_code** | **str** | Chapter 3 status code for the intermediary or flow-through entity. Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary | [optional] +**chap4_status_code** | **str** | Chapter 4 status code for the intermediary or flow-through entity. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI | [optional] **name** | **str** | Name of the intermediary or flow-through entity | [optional] **giin** | **str** | GIIN (Global Intermediary Identification Number) of the intermediary or flow-through entity | [optional] **country_code** | **str** | Country code for the intermediary or flow-through entity | [optional] diff --git a/docs/A1099/V2/IssuerBase.md b/docs/A1099/V2/IssuerBase.md new file mode 100644 index 0000000..0deef0d --- /dev/null +++ b/docs/A1099/V2/IssuerBase.md @@ -0,0 +1,43 @@ +# IssuerBase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Legal name. Not the DBA name. | +**dba_name** | **str** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] +**tin** | **str** | Federal Tax Identification Number (TIN). | [optional] +**reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces. | [optional] +**telephone** | **str** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. | +**tax_year** | **int** | Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. | +**country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address. | [optional] +**email** | **str** | Contact email address. For recipient inquiries. | +**address** | **str** | Address. | +**city** | **str** | City. | +**state** | **str** | Two-letter US state or Canadian province code (required for US/CA addresses). | +**zip** | **str** | ZIP/postal code. | +**foreign_province** | **str** | Province or region for non-US/CA addresses. | [optional] +**transfer_agent_name** | **str** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] +**last_filing** | **bool** | Indicates if this is the issuer's final year filing. | + +## Example + +```python +from Avalara.SDK.models.A1099.V2.issuer_base import IssuerBase + +# TODO update the JSON string below +json = "{}" +# create an instance of IssuerBase from a JSON string +issuer_base_instance = IssuerBase.from_json(json) +# print the JSON string representation of the object +print(IssuerBase.to_json()) + +# convert the object into a dict +issuer_base_dict = issuer_base_instance.to_dict() +# create an instance of IssuerBase from a dict +issuer_base_from_dict = IssuerBase.from_dict(issuer_base_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/A1099/V2/IssuerRequest.md b/docs/A1099/V2/IssuerRequest.md new file mode 100644 index 0000000..3eacf2b --- /dev/null +++ b/docs/A1099/V2/IssuerRequest.md @@ -0,0 +1,43 @@ +# IssuerRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Legal name. Not the DBA name. | +**dba_name** | **str** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] +**tin** | **str** | Federal Tax Identification Number (TIN). | [optional] +**reference_id** | **str** | Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces. | [optional] +**telephone** | **str** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. | +**tax_year** | **int** | Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. | +**country_code** | **str** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address. | [optional] +**email** | **str** | Contact email address. For recipient inquiries. | +**address** | **str** | Address. | +**city** | **str** | City. | +**state** | **str** | Two-letter US state or Canadian province code (required for US/CA addresses). | +**zip** | **str** | ZIP/postal code. | +**foreign_province** | **str** | Province or region for non-US/CA addresses. | [optional] +**transfer_agent_name** | **str** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] +**last_filing** | **bool** | Indicates if this is the issuer's final year filing. | + +## Example + +```python +from Avalara.SDK.models.A1099.V2.issuer_request import IssuerRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of IssuerRequest from a JSON string +issuer_request_instance = IssuerRequest.from_json(json) +# print the JSON string representation of the object +print(IssuerRequest.to_json()) + +# convert the object into a dict +issuer_request_dict = issuer_request_instance.to_dict() +# create an instance of IssuerRequest from a dict +issuer_request_from_dict = IssuerRequest.from_dict(issuer_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/A1099/V2/Issuers1099Api.md b/docs/A1099/V2/Issuers1099Api.md index f7f6557..008f17f 100644 --- a/docs/A1099/V2/Issuers1099Api.md +++ b/docs/A1099/V2/Issuers1099Api.md @@ -26,7 +26,7 @@ Create an issuer (also known as a Payer). import time import Avalara.SDK from Avalara.SDK.api.A1099.V2 import issuers1099_api -CreateIssuerRequest +IssuerRequest IssuerResponse ErrorResponse from pprint import pprint @@ -45,9 +45,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = issuers1099_api.Issuers1099Api(api_client) avalara_version = '2.0.0' # str | API version - x_correlation_id = '26a8ae54-5655-49b3-b01a-f4203094a5ef' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '5c70e4f3-3885-4757-84f3-86323c1af033' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - create_issuer_request = {"name":"Acme Corporation","dbaName":"Acme Widgets","tin":"94-2765431","referenceId":"issuer-001","telephone":"+1-555-123-4567","taxYear":2024,"countryCode":"US","email":"support@acmecorp.com","address":"123 Main Street","city":"San Francisco","state":"CA","zip":"94105","foreignProvince":"","transferAgentName":"","lastFiling":false} # CreateIssuerRequest | The issuer to create (optional) + issuer_request = {"name":"Acme Corporation","dbaName":"Acme Widgets","tin":"94-2765431","referenceId":"issuer-001","telephone":"+1-555-123-4567","taxYear":2024,"countryCode":"US","email":"support@acmecorp.com","address":"123 Main Street","city":"San Francisco","state":"CA","zip":"94105","foreignProvince":"","transferAgentName":"","lastFiling":false} # IssuerRequest | The issuer to create (optional) # example passing only required values which don't have defaults set try: # Create an issuer @@ -60,7 +60,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # and optional values try: # Create an issuer - api_response = api_instance.create_issuer(avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, create_issuer_request=create_issuer_request) + api_response = api_instance.create_issuer(avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, issuer_request=issuer_request) pprint(api_response) except Avalara.SDK.ApiException as e: print("Exception when calling Issuers1099Api->create_issuer: %s\n" % e) @@ -73,7 +73,7 @@ Name | Type | Description | Notes **avalara_version** | **str**| API version | **x_correlation_id** | **str**| Unique correlation Id in a GUID format | [optional] **x_avalara_client** | **str**| Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] - **create_issuer_request** | [**CreateIssuerRequest**](CreateIssuerRequest.md)| The issuer to create | [optional] + **issuer_request** | [**IssuerRequest**](IssuerRequest.md)| The issuer to create | [optional] ### Return type @@ -132,7 +132,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = issuers1099_api.Issuers1099Api(api_client) id = 'id_example' # str | Id of the issuer to delete avalara_version = '2.0.0' # str | API version - x_correlation_id = 'b8d102b3-3e63-4e6e-9735-25f17b0c69a7' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'ebe59aa0-745c-44da-b86b-67ad7994619c' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -217,7 +217,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = issuers1099_api.Issuers1099Api(api_client) id = 'id_example' # str | Id of the issuer to retrieve avalara_version = '2.0.0' # str | API version - x_correlation_id = 'fc90ea70-0e20-46ed-a73c-80e99e89f3d5' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'cfc604e9-15ae-4c65-a59f-123475fad2ef' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -309,7 +309,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: order_by = 'order_by_example' # str | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. (optional) count = True # bool | If true, return the global count of elements in the collection. (optional) count_only = True # bool | If true, return ONLY the global count of elements in the collection. It only applies when count=true. (optional) - x_correlation_id = '8c33cfd6-f102-4192-9001-24fed7baee29' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '3302a30f-61fc-4b94-af04-c683c6064eed' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: @@ -384,7 +384,7 @@ Update an issuer (also known as a Payer). import time import Avalara.SDK from Avalara.SDK.api.A1099.V2 import issuers1099_api -CreateIssuerRequest +IssuerRequest ErrorResponse from pprint import pprint @@ -403,9 +403,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = issuers1099_api.Issuers1099Api(api_client) id = 'id_example' # str | Id of the issuer to update avalara_version = '2.0.0' # str | API version - x_correlation_id = 'c353a7ba-0386-49f8-97a8-378cd39452ea' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = '4f30c58e-f8fd-4635-99d4-ea710f1d0182' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) - create_issuer_request = {"name":"Acme Corporation","dbaName":"Acme Widgets","tin":"94-2765431","referenceId":"issuer-001","telephone":"+1-555-123-4567","taxYear":2024,"countryCode":"US","email":"support@acmecorp.com","address":"123 Main Street","city":"San Francisco","state":"CA","zip":"94105","foreignProvince":"","transferAgentName":"","lastFiling":false} # CreateIssuerRequest | The issuer to update (optional) + issuer_request = {"name":"Acme Corporation","dbaName":"Acme Widgets","tin":"94-2765431","referenceId":"issuer-001","telephone":"+1-555-123-4567","taxYear":2024,"countryCode":"US","email":"support@acmecorp.com","address":"123 Main Street","city":"San Francisco","state":"CA","zip":"94105","foreignProvince":"","transferAgentName":"","lastFiling":false} # IssuerRequest | The issuer to update (optional) # example passing only required values which don't have defaults set try: # Update an issuer @@ -417,7 +417,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # and optional values try: # Update an issuer - api_instance.update_issuer(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, create_issuer_request=create_issuer_request) + api_instance.update_issuer(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, issuer_request=issuer_request) except Avalara.SDK.ApiException as e: print("Exception when calling Issuers1099Api->update_issuer: %s\n" % e) ``` @@ -430,7 +430,7 @@ Name | Type | Description | Notes **avalara_version** | **str**| API version | **x_correlation_id** | **str**| Unique correlation Id in a GUID format | [optional] **x_avalara_client** | **str**| Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] - **create_issuer_request** | [**CreateIssuerRequest**](CreateIssuerRequest.md)| The issuer to update | [optional] + **issuer_request** | [**IssuerRequest**](IssuerRequest.md)| The issuer to update | [optional] ### Return type diff --git a/docs/A1099/V2/JobsApi.md b/docs/A1099/V2/JobsApi.md index 8ad98f0..5621248 100644 --- a/docs/A1099/V2/JobsApi.md +++ b/docs/A1099/V2/JobsApi.md @@ -41,7 +41,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = jobs_api.JobsApi(api_client) id = 'id_example' # str | Job id obtained from other API responses, like `/1099/bulk-upsert`. avalara_version = '2.0.0' # str | API version - x_correlation_id = 'b5e99bb8-41d6-4f87-8677-070497e8fba3' # str | Unique correlation Id in a GUID format (optional) + x_correlation_id = 'af6414fe-0bd6-4ddb-91bb-43108aa78fa5' # str | Unique correlation Id in a GUID format (optional) x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional) # example passing only required values which don't have defaults set try: diff --git a/docs/A1099/V2/W4FormMinimalRequest.md b/docs/A1099/V2/W4FormMinimalRequest.md index da76e8b..2af04e2 100644 --- a/docs/A1099/V2/W4FormMinimalRequest.md +++ b/docs/A1099/V2/W4FormMinimalRequest.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **employee_first_name** | **str** | The first name of the employee. | **employee_last_name** | **str** | The last name of the employee. | **office_code** | **str** | The office code associated with the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] ## Example diff --git a/docs/A1099/V2/W4FormRequest.md b/docs/A1099/V2/W4FormRequest.md index cc4bb37..3f684b3 100644 --- a/docs/A1099/V2/W4FormRequest.md +++ b/docs/A1099/V2/W4FormRequest.md @@ -6,17 +6,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | The form type (always \"w4\" for this model). | [optional] [readonly] -**employee_first_name** | **str** | The first name of the employee. | [optional] +**employee_first_name** | **str** | The first name of the employee. | **employee_middle_name** | **str** | The middle name of the employee. | [optional] -**employee_last_name** | **str** | The last name of the employee. | [optional] +**employee_last_name** | **str** | The last name of the employee. | **employee_name_suffix** | **str** | The name suffix of the employee. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] -**tin** | **str** | The taxpayer identification number (TIN). | [optional] -**address** | **str** | The address of the employee. | [optional] -**city** | **str** | The city of residence of the employee. | [optional] -**state** | **str** | The state of residence of the employee. | [optional] -**zip** | **str** | The ZIP code of residence of the employee. | [optional] -**marital_status** | **str** | The marital status of the employee. | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. | +**tin** | **str** | The taxpayer identification number (TIN). | +**address** | **str** | The address of the employee. Required unless exempt. | [optional] +**city** | **str** | The city of residence of the employee. Required unless exempt. | [optional] +**state** | **str** | The state of residence of the employee. Required unless exempt. | [optional] +**zip** | **str** | The ZIP code of residence of the employee. Required unless exempt. | [optional] +**marital_status** | **str** | The marital status of the employee. Required unless exempt. Available values: - Single: Single or Married filing separately - Married: Married filing jointly or qualifying surviving spouse - MarriedBut: Head of household. Check only if you're unmarried and pay more than half the costs of keeping up a home for yourself and a qualifying individual. | [optional] **last_name_differs** | **bool** | Indicates whether the last name differs from prior records. | [optional] **num_allowances** | **int** | The number of allowances claimed by the employee. | [optional] **other_dependents** | **int** | The number of dependents other than allowances. | [optional] @@ -27,7 +27,7 @@ Name | Type | Description | Notes **office_code** | **str** | The office code associated with the form. | [optional] **e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] **signature** | **str** | The signature of the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **email** | **str** | The email address of the individual associated with the form. | [optional] diff --git a/docs/A1099/V2/W4FormResponse.md b/docs/A1099/V2/W4FormResponse.md index 488e06d..4369ccb 100644 --- a/docs/A1099/V2/W4FormResponse.md +++ b/docs/A1099/V2/W4FormResponse.md @@ -5,11 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | The form type (always \"W4\" for this model). | [optional] [readonly] **employee_first_name** | **str** | The first name of the employee. | [optional] **employee_middle_name** | **str** | The middle name of the employee. | [optional] **employee_last_name** | **str** | The last name of the employee. | [optional] **employee_name_suffix** | **str** | The name suffix of the employee. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. | [optional] **tin** | **str** | The taxpayer identification number (TIN). | [optional] **address** | **str** | The address of the employee. | [optional] **city** | **str** | The city of residence of the employee. | [optional] @@ -24,6 +25,19 @@ Name | Type | Description | Notes **additional_withheld** | **float** | The additional amount withheld. | [optional] **exempt_from_withholding** | **bool** | Indicates whether the employee is exempt from withholding. | [optional] **office_code** | **str** | The office code associated with the form. | [optional] +**id** | **str** | The unique identifier for the form. | [optional] +**entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] +**reference_id** | **str** | A reference identifier for the form. | [optional] +**company_id** | **str** | The ID of the associated company. | [optional] +**display_name** | **str** | The display name associated with the form. | [optional] +**email** | **str** | The email address of the individual associated with the form. | [optional] +**archived** | **bool** | Indicates whether the form is archived. | [optional] +**ancestor_id** | **str** | Form ID of previous version. | [optional] +**signature** | **str** | The signature of the form. | [optional] +**signed_date** | **datetime** | The date the form was signed. | [optional] +**e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] +**created_at** | **datetime** | The creation date of the form. | [optional] +**updated_at** | **datetime** | The last updated date of the form. | [optional] ## Example diff --git a/docs/A1099/V2/W8BenEFormMinimalRequest.md b/docs/A1099/V2/W8BenEFormMinimalRequest.md index afd469a..7072c13 100644 --- a/docs/A1099/V2/W8BenEFormMinimalRequest.md +++ b/docs/A1099/V2/W8BenEFormMinimalRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **email** | **str** | The email address of the individual associated with the form. | **name** | **str** | The name of the individual or entity associated with the form. | **reference_number** | **str** | A reference number for the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] ## Example diff --git a/docs/A1099/V2/W8BenEFormRequest.md b/docs/A1099/V2/W8BenEFormRequest.md index 8019a26..8c1bad2 100644 --- a/docs/A1099/V2/W8BenEFormRequest.md +++ b/docs/A1099/V2/W8BenEFormRequest.md @@ -6,17 +6,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | The form type (always \"w8bene\" for this model). | [optional] [readonly] -**name** | **str** | The name of the individual or entity associated with the form. | [optional] -**citizenship_country** | **str** | The country of citizenship. | [optional] +**name** | **str** | The name of the individual or entity associated with the form. | +**citizenship_country** | **str** | The country of citizenship. | **disregarded_entity** | **str** | The name of the disregarded entity receiving the payment (if applicable). | [optional] -**entity_type** | **str** | The entity type. | [optional] +**entity_type** | **str** | The entity type. Available values: - 1: Corporation - 2: Disregarded entity - 3: Partnership - 4: Simple trust - 5: Grantor trust - 6: Complex trust - 7: Estate - 8: Foreign Government - Controlled Entity - 9: Central Bank of Issue - 10: Tax-exempt organization - 11: Private foundation - 12: International organization - 13: Foreign Government - Controlled Integral Part | **making_treaty_claim** | **bool** | Indicates whether the entity is making a treaty claim. | [optional] -**fatca_status** | **str** | The FATCA status. | [optional] +**fatca_status** | **str** | The FATCA status. Available values: - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner) - 2: Participating FFI - 3: Reporting Model 1 FFI - 4: Reporting Model 2 FFI - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII) - 6: Sponsored FFI that has not obtained a GIIN - 7: Certified deemed-compliant nonregistering local bank - 8: Certified deemed-compliant FFI with only low-value accounts - 9: Certified deemed-compliant sponsored, closely held investment vehicle - 10: Certified deemed-compliant limited life debt investment entity - 11: Certified deemed-compliant investment advisors and investment managers - 12: Owner-documented FFI - 13: Restricted distributor - 14: Nonreporting IGA FFI - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue - 16: International organization - 17: Exempt retirement plans - 18: Entity wholly owned by exempt beneficial owners - 19: Territory financial institution - 20: Nonfinancial group entity - 21: Excepted nonfinancial start-up company - 22: Excepted nonfinancial entity in liquidation or bankruptcy - 23: 501(c) organization - 24: Nonprofit organization - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation - 26: Excepted territory NFFE - 27: Active NFFE - 28: Passive NFFE - 29: Excepted inter-affiliate FFI - 30: Direct reporting NFFE - 31: Sponsored direct reporting NFFE - 32: Account that is not a financial account | **residence_address** | **str** | The residential address of the individual or entity. | [optional] **residence_city** | **str** | The city of residence. | [optional] **residence_state** | **str** | The state of residence. | [optional] **residence_zip** | **str** | The ZIP code of the residence. | [optional] -**residence_country** | **str** | The country of residence. | [optional] +**residence_country** | **str** | The country of residence. | **residence_is_mailing** | **bool** | Indicates whether the residence address is also the mailing address. | [optional] **mailing_address** | **str** | The mailing address. | [optional] **mailing_city** | **str** | The city of the mailing address. | [optional] @@ -28,7 +28,7 @@ Name | Type | Description | Notes **foreign_tin_not_required** | **bool** | Indicates whether a foreign TIN is not required. | [optional] **foreign_tin** | **str** | The foreign taxpayer identification number (TIN). | [optional] **reference_number** | **str** | A reference number for the form. | [optional] -**disregarded_entity_fatca_status** | **str** | The FATCA status of disregarded entity or branch receiving payment. | [optional] +**disregarded_entity_fatca_status** | **str** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Limited Branch - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI | [optional] **disregarded_address** | **str** | The address for disregarded entities. | [optional] **disregarded_city** | **str** | The city for disregarded entities. | [optional] **disregarded_state** | **str** | The state for disregarded entities. | [optional] @@ -38,7 +38,7 @@ Name | Type | Description | Notes **treaty_country_certification** | **bool** | Certifies the beneficial owner's country under the U.S. tax treaty. | [optional] **treaty_country** | **str** | The treaty country of the beneficial owner. | [optional] **benefit_limitation_certification** | **bool** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional] -**benefit_limitation** | **str** | The benefit limitation for tax treaty claims. | [optional] +**benefit_limitation** | **str** | The benefit limitation for tax treaty claims. Available values: - 1: Government - 2: Tax exempt pension trust or pension fund - 3: Other tax exempt organization - 4: Publicly traded corporation - 5: Subsidiary of a publicly traded corporation - 6: Company that meets the ownership and base erosion test - 7: Company that meets the derivative benefits test - 8: Company with an item of income that meets active trade or business test - 9: Favorable discretionary determination by the U.S. competent authority received - 10: Other | [optional] **qualified_resident_status_certification** | **bool** | Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. | [optional] **treaty_article** | **str** | Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits. | [optional] **withholding_rate** | **str** | Specifies the reduced withholding rate claimed under the applicable tax treaty. | [optional] @@ -62,7 +62,7 @@ Name | Type | Description | Notes **restricted_distributor_preexisting_sales_compliance_certification** | **bool** | Certifies that the entity complies with distribution restrictions for U.S.-linked investors and has addressed any preexisting sales in accordance with FATCA regulations. | [optional] **nonreporting_iga_ffi_certification** | **bool** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] **iga_country** | **str** | The country for the applicable IGA with the United States. | [optional] -**iga_model** | **str** | The applicable IGA model. | [optional] +**iga_model** | **str** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] **iga_legal_status_treatment** | **str** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] **iga_ffi_trustee_or_sponsor** | **str** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] **iga_ffi_trustee_is_foreign** | **bool** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] @@ -103,7 +103,7 @@ Name | Type | Description | Notes **capacity_to_sign_certification** | **bool** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] **e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] **signature** | **str** | The signature of the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **email** | **str** | The email address of the individual associated with the form. | [optional] diff --git a/docs/A1099/V2/W8BenEFormResponse.md b/docs/A1099/V2/W8BenEFormResponse.md index 84b8502..a0325ab 100644 --- a/docs/A1099/V2/W8BenEFormResponse.md +++ b/docs/A1099/V2/W8BenEFormResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | The form type (always \"W8BenE\" for this model). | [optional] [readonly] **name** | **str** | The name of the individual or entity associated with the form. | [optional] **citizenship_country** | **str** | The country of citizenship. | [optional] **disregarded_entity** | **str** | The name of the disregarded entity receiving the payment (if applicable). | [optional] @@ -22,7 +23,7 @@ Name | Type | Description | Notes **mailing_state** | **str** | The state of the mailing address. | [optional] **mailing_zip** | **str** | The ZIP code of the mailing address. | [optional] **mailing_country** | **str** | The country of the mailing address. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. | [optional] **tin** | **str** | The taxpayer identification number (TIN). | [optional] **giin** | **str** | The global intermediary identification number (GIIN). | [optional] **foreign_tin_not_required** | **bool** | Indicates whether a foreign TIN is not required. | [optional] @@ -101,6 +102,19 @@ Name | Type | Description | Notes **substantial_us_owners** | [**List[SubstantialUsOwnerResponse]**](SubstantialUsOwnerResponse.md) | The list of substantial U.S. owners of passive NFFE. | [optional] **signer_name** | **str** | The name of the signer. | [optional] **capacity_to_sign_certification** | **bool** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] +**id** | **str** | The unique identifier for the form. | [optional] +**entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] +**reference_id** | **str** | A reference identifier for the form. | [optional] +**company_id** | **str** | The ID of the associated company. | [optional] +**display_name** | **str** | The display name associated with the form. | [optional] +**email** | **str** | The email address of the individual associated with the form. | [optional] +**archived** | **bool** | Indicates whether the form is archived. | [optional] +**ancestor_id** | **str** | Form ID of previous version. | [optional] +**signature** | **str** | The signature of the form. | [optional] +**signed_date** | **datetime** | The date the form was signed. | [optional] +**e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] +**created_at** | **datetime** | The creation date of the form. | [optional] +**updated_at** | **datetime** | The last updated date of the form. | [optional] ## Example diff --git a/docs/A1099/V2/W8BenFormMinimalRequest.md b/docs/A1099/V2/W8BenFormMinimalRequest.md index 986d08a..f4f9a00 100644 --- a/docs/A1099/V2/W8BenFormMinimalRequest.md +++ b/docs/A1099/V2/W8BenFormMinimalRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **email** | **str** | The email address of the individual associated with the form. | **name** | **str** | The name of the individual or entity associated with the form. | **reference_number** | **str** | A reference number for the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] ## Example diff --git a/docs/A1099/V2/W8BenFormRequest.md b/docs/A1099/V2/W8BenFormRequest.md index c38d27d..a4e29a0 100644 --- a/docs/A1099/V2/W8BenFormRequest.md +++ b/docs/A1099/V2/W8BenFormRequest.md @@ -6,19 +6,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | The form type (always \"w8ben\" for this model). | [optional] [readonly] -**name** | **str** | The name of the individual or entity associated with the form. | [optional] -**citizenship_country** | **str** | The country of citizenship. | [optional] +**name** | **str** | The name of the individual or entity associated with the form. | +**citizenship_country** | **str** | The country of citizenship. | **residence_address** | **str** | The residential address of the individual or entity. | [optional] **residence_city** | **str** | The city of residence. | [optional] **residence_state** | **str** | The state of residence. | [optional] **residence_zip** | **str** | The ZIP code of the residence. | [optional] -**residence_country** | **str** | The country of residence. | [optional] +**residence_country** | **str** | The country of residence. | **residence_is_mailing** | **bool** | Indicates whether the residence address is the mailing address. | [optional] **mailing_address** | **str** | The mailing address. | [optional] **mailing_city** | **str** | The city of the mailing address. | [optional] **mailing_state** | **str** | The state of the mailing address. | [optional] **mailing_zip** | **str** | The ZIP code of the mailing address. | [optional] -**mailing_country** | **str** | The country of the mailing address. | [optional] +**mailing_country** | **str** | The country of the mailing address. | **tin** | **str** | The taxpayer identification number (TIN). | [optional] **foreign_tin_not_required** | **bool** | Indicates whether a foreign TIN is not legally required. | [optional] **foreign_tin** | **str** | The foreign taxpayer identification number (TIN). | [optional] @@ -32,7 +32,7 @@ Name | Type | Description | Notes **signer_name** | **str** | The name of the signer of the form. | [optional] **e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] **signature** | **str** | The signature of the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **email** | **str** | The email address of the individual associated with the form. | [optional] diff --git a/docs/A1099/V2/W8BenFormResponse.md b/docs/A1099/V2/W8BenFormResponse.md index bc9ad55..b2ad952 100644 --- a/docs/A1099/V2/W8BenFormResponse.md +++ b/docs/A1099/V2/W8BenFormResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | The form type (always \"W8Ben\" for this model). | [optional] [readonly] **name** | **str** | The name of the individual or entity associated with the form. | [optional] **citizenship_country** | **str** | The country of citizenship. | [optional] **residence_address** | **str** | The residential address of the individual or entity. | [optional] @@ -18,7 +19,7 @@ Name | Type | Description | Notes **mailing_state** | **str** | The state of the mailing address. | [optional] **mailing_zip** | **str** | The ZIP code of the mailing address. | [optional] **mailing_country** | **str** | The country of the mailing address. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. | [optional] **tin** | **str** | The taxpayer identification number (TIN). | [optional] **foreign_tin_not_required** | **bool** | Indicates whether a foreign TIN is not required. | [optional] **foreign_tin** | **str** | The foreign taxpayer identification number (TIN). | [optional] @@ -31,6 +32,19 @@ Name | Type | Description | Notes **income_type** | **str** | The type of income covered by the treaty. | [optional] **signer_name** | **str** | The name of the signer of the form. | [optional] **signer_capacity** | **str** | The capacity in which the signer is signing the form. | [optional] +**id** | **str** | The unique identifier for the form. | [optional] +**entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] +**reference_id** | **str** | A reference identifier for the form. | [optional] +**company_id** | **str** | The ID of the associated company. | [optional] +**display_name** | **str** | The display name associated with the form. | [optional] +**email** | **str** | The email address of the individual associated with the form. | [optional] +**archived** | **bool** | Indicates whether the form is archived. | [optional] +**ancestor_id** | **str** | Form ID of previous version. | [optional] +**signature** | **str** | The signature of the form. | [optional] +**signed_date** | **datetime** | The date the form was signed. | [optional] +**e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] +**created_at** | **datetime** | The creation date of the form. | [optional] +**updated_at** | **datetime** | The last updated date of the form. | [optional] ## Example diff --git a/docs/A1099/V2/W8ImyFormMinimalRequest.md b/docs/A1099/V2/W8ImyFormMinimalRequest.md index 92e722f..abdc74b 100644 --- a/docs/A1099/V2/W8ImyFormMinimalRequest.md +++ b/docs/A1099/V2/W8ImyFormMinimalRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **email** | **str** | The email address of the individual associated with the form. | **name** | **str** | The name of the individual or entity associated with the form. | **reference_number** | **str** | A reference number for the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] ## Example diff --git a/docs/A1099/V2/W8ImyFormRequest.md b/docs/A1099/V2/W8ImyFormRequest.md index 7a30a19..8ff0e5d 100644 --- a/docs/A1099/V2/W8ImyFormRequest.md +++ b/docs/A1099/V2/W8ImyFormRequest.md @@ -6,28 +6,28 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | The form type (always \"w8imy\" for this model). | [optional] [readonly] -**name** | **str** | The name of the individual or entity associated with the form. | [optional] -**citizenship_country** | **str** | The country of citizenship. | [optional] +**name** | **str** | The name of the individual or entity associated with the form. | +**citizenship_country** | **str** | The country of citizenship. | **disregarded_entity** | **str** | The name of the disregarded entity receiving the payment (if applicable). | [optional] -**entity_type** | **str** | The entity type. | [optional] -**fatca_status** | **str** | The FATCA status. | [optional] +**entity_type** | **str** | The entity type. Available values: - 1: QI (including a QDD). Complete Part III. - 2: Nonqualified intermediary. Complete Part IV. - 3: Territory financial institution. Complete Part V. - 4: U.S. branch. Complete Part VI. - 5: Withholding foreign partnership. Complete Part VII. - 6: Withholding foreign trust. Complete Part VII. - 7: Nonwithholding foreign partnership. Complete Part VIII. - 8: Nonwithholding foreign simple trust. Complete Part VIII. - 9: Nonwithholding foreign grantor trust. Complete Part VIII. | +**fatca_status** | **str** | The FATCA status. Available values: - 1: Nonparticipating foreign financial institution (FFI) (including an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner). Complete Part IX (if applicable). - 2: Participating FFI. - 3: Reporting Model 1 FFI. - 4: Reporting Model 2 FFI. - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XIX). - 6: Territory financial institution. Complete Part V. - 7: Sponsored FFI (other than a certified deemed-compliant sponsored, closely held investment vehicle). Complete Part X. - 8: Certified deemed-compliant nonregistering local bank. Complete Part XII. - 9: Certified deemed-compliant FFI with only low-value accounts. Complete Part XIII. - 10: Certified deemed-compliant sponsored, closely held investment vehicle. Complete Part XIV. - 11: Certified deemed-compliant limited life debt investment entity. Complete Part XV. - 12: Certain investment entities that do not maintain financial accounts. Complete Part XVI. - 13: Owner-documented FFI. Complete Part XI. - 14: Restricted distributor. Complete Part XVII. - 15: Foreign central bank of issue. Complete Part XVIII. - 16: Nonreporting IGA FFI. Complete Part XIX. - 17: Exempt retirement plans. Complete Part XX. - 18: Excepted nonfinancial group entity. Complete Part XXI. - 19: Excepted nonfinancial start-up company. Complete Part XXII. - 20: Excepted nonfinancial entity in liquidation or bankruptcy. Complete Part XXIII. - 21: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation. Complete Part XXIV. - 22: Excepted territory NFFE. Complete Part XXV. - 23: Active NFFE. Complete Part XXVI. - 24: Passive NFFE. Complete Part XXVII. - 25: Direct reporting NFFE. - 26: Sponsored direct reporting NFFE. Complete Part XXVIII. | [optional] **residence_address** | **str** | The residential address of the individual or entity. | [optional] **residence_city** | **str** | The city of residence. | [optional] **residence_state** | **str** | The state of residence. | [optional] **residence_zip** | **str** | The ZIP code of the residence. | [optional] -**residence_country** | **str** | The country of residence. | [optional] +**residence_country** | **str** | The country of residence. | **residence_is_mailing** | **bool** | Indicates whether the residence address is also the mailing address. | [optional] **mailing_address** | **str** | The mailing address. | [optional] **mailing_city** | **str** | The city of the mailing address. | [optional] **mailing_state** | **str** | The state of the mailing address. | [optional] **mailing_zip** | **str** | The ZIP code of the mailing address. | [optional] **mailing_country** | **str** | The country of the mailing address. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. Available values: - QI-EIN: Qualified Intermediary EIN - WP-EIN: Withholding Partnership EIN - WT-EIN: Withholding Trust EIN - EIN: Employer Identification Number | [optional] **tin** | **str** | The taxpayer identification number (TIN). | [optional] **giin** | **str** | The global intermediary identification number (GIIN). | [optional] **foreign_tin** | **str** | The foreign taxpayer identification number (TIN). | [optional] **reference_number** | **str** | A reference number for the form. | [optional] -**disregarded_entity_fatca_status** | **str** | The FATCA status of disregarded entity or branch receiving payment. | [optional] +**disregarded_entity_fatca_status** | **str** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Branch treated as nonparticipating FFI. - 2: Participating FFI. - 3: Reporting Model 1 FFI. - 4: Reporting Model 2 FFI. - 5: U.S. Branch | [optional] **disregarded_address** | **str** | The address for disregarded entities. | [optional] **disregarded_city** | **str** | The city for disregarded entities. | [optional] **disregarded_state** | **str** | The state for disregarded entities. | [optional] @@ -91,7 +91,7 @@ Name | Type | Description | Notes **foreign_central_bank_of_issue_certification** | **bool** | Certifies that the entity is treated as the beneficial owner of the payment solely for purposes of chapter 4 under Regulations section 1.1471-6(d)(4). | [optional] **nonreporting_iga_ffi_certification** | **bool** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] **iga_country** | **str** | The country for the applicable IGA with the United States. | [optional] -**iga_model** | **str** | The applicable IGA model. | [optional] +**iga_model** | **str** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] **iga_legal_status_treatment** | **str** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] **iga_ffi_trustee_or_sponsor** | **str** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] **iga_ffi_trustee_is_foreign** | **bool** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] @@ -119,7 +119,7 @@ Name | Type | Description | Notes **signer_name** | **str** | The name of the signer. | [optional] **e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] **signature** | **str** | The signature of the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **email** | **str** | The email address of the individual associated with the form. | [optional] diff --git a/docs/A1099/V2/W8ImyFormResponse.md b/docs/A1099/V2/W8ImyFormResponse.md index bd3fecb..3260441 100644 --- a/docs/A1099/V2/W8ImyFormResponse.md +++ b/docs/A1099/V2/W8ImyFormResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | The form type (always \"W8Imy\" for this model). | [optional] [readonly] **name** | **str** | The name of the individual or entity associated with the form. | [optional] **citizenship_country** | **str** | The country of citizenship. | [optional] **disregarded_entity** | **str** | The name of the disregarded entity receiving the payment (if applicable). | [optional] @@ -21,7 +22,7 @@ Name | Type | Description | Notes **mailing_state** | **str** | The state of the mailing address. | [optional] **mailing_zip** | **str** | The ZIP code of the mailing address. | [optional] **mailing_country** | **str** | The country of the mailing address. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. | [optional] **tin** | **str** | The taxpayer identification number (TIN). | [optional] **giin** | **str** | The global intermediary identification number (GIIN). | [optional] **foreign_tin** | **str** | The foreign taxpayer identification number (TIN). | [optional] @@ -116,6 +117,19 @@ Name | Type | Description | Notes **sponsored_direct_reporting_nffe_certification** | **bool** | Certifies that the entity is a sponsored direct reporting NFFE. | [optional] **direct_reporting_nffe_sponsoring_entity** | **str** | The name of the entity that sponsors the direct reporting NFFE. | [optional] **signer_name** | **str** | The name of the signer. | [optional] +**id** | **str** | The unique identifier for the form. | [optional] +**entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] +**reference_id** | **str** | A reference identifier for the form. | [optional] +**company_id** | **str** | The ID of the associated company. | [optional] +**display_name** | **str** | The display name associated with the form. | [optional] +**email** | **str** | The email address of the individual associated with the form. | [optional] +**archived** | **bool** | Indicates whether the form is archived. | [optional] +**ancestor_id** | **str** | Form ID of previous version. | [optional] +**signature** | **str** | The signature of the form. | [optional] +**signed_date** | **datetime** | The date the form was signed. | [optional] +**e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] +**created_at** | **datetime** | The creation date of the form. | [optional] +**updated_at** | **datetime** | The last updated date of the form. | [optional] ## Example diff --git a/docs/A1099/V2/W9FormBaseMinimalRequest.md b/docs/A1099/V2/W9FormBaseMinimalRequest.md index aa94b35..ef3fe62 100644 --- a/docs/A1099/V2/W9FormBaseMinimalRequest.md +++ b/docs/A1099/V2/W9FormBaseMinimalRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | The form type. | [optional] [readonly] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **email** | **str** | The email address of the individual associated with the form. | [optional] diff --git a/docs/A1099/V2/W9FormBaseRequest.md b/docs/A1099/V2/W9FormBaseRequest.md index af2e7fa..c034f10 100644 --- a/docs/A1099/V2/W9FormBaseRequest.md +++ b/docs/A1099/V2/W9FormBaseRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] **signature** | **str** | The signature of the form. | [optional] **type** | **str** | The form type. | [optional] [readonly] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **email** | **str** | The email address of the individual associated with the form. | [optional] diff --git a/docs/A1099/V2/W9FormBaseResponse.md b/docs/A1099/V2/W9FormBaseResponse.md index 32cd808..04dbc67 100644 --- a/docs/A1099/V2/W9FormBaseResponse.md +++ b/docs/A1099/V2/W9FormBaseResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | The form type. | [optional] [readonly] **id** | **str** | The unique identifier for the form. | [optional] **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] @@ -18,7 +19,6 @@ Name | Type | Description | Notes **e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] **created_at** | **datetime** | The creation date of the form. | [optional] **updated_at** | **datetime** | The last updated date of the form. | [optional] -**type** | **str** | The type of the response object. | [optional] ## Example diff --git a/docs/A1099/V2/W9FormMinimalRequest.md b/docs/A1099/V2/W9FormMinimalRequest.md index 6f53d38..29d4588 100644 --- a/docs/A1099/V2/W9FormMinimalRequest.md +++ b/docs/A1099/V2/W9FormMinimalRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **email** | **str** | The email address of the individual associated with the form. | **name** | **str** | The name of the individual or entity associated with the form. | **account_number** | **str** | The account number associated with the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] ## Example diff --git a/docs/A1099/V2/W9FormRequest.md b/docs/A1099/V2/W9FormRequest.md index 5801993..870bd59 100644 --- a/docs/A1099/V2/W9FormRequest.md +++ b/docs/A1099/V2/W9FormRequest.md @@ -6,27 +6,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | The form type (always \"w9\" for this model). | [optional] [readonly] -**name** | **str** | The name of the individual or entity associated with the form. | [optional] +**name** | **str** | The name of the individual or entity associated with the form. | **business_name** | **str** | The name of the business associated with the form. | [optional] -**business_classification** | **str** | The classification of the business. | [optional] +**business_classification** | **str** | The classification of the business. Available values: - Individual: Individual/sole proprietor - C Corporation: C Corporation - S Corporation: S Corporation - Partnership: Partnership - Trust/estate: Trust/estate - LLC-C: Limited liability company (C Corporation) - LLC-S: Limited liability company (S Corporation) - LLC-P: Limited liability company (Partnership) - Other: Other (requires BusinessOther field to be populated) | **business_other** | **str** | The classification description when \"businessClassification\" is \"Other\". | [optional] **foreign_partner_owner_or_beneficiary** | **bool** | Indicates whether the individual is a foreign partner, owner, or beneficiary. | [optional] **exempt_payee_code** | **str** | The exempt payee code. | [optional] **exempt_fatca_code** | **str** | The exemption from FATCA reporting code. | [optional] **foreign_country_indicator** | **bool** | Indicates whether the individual or entity is in a foreign country. | [optional] -**address** | **str** | The address of the individual or entity. | [optional] +**address** | **str** | The address of the individual or entity. | **foreign_address** | **str** | The foreign address of the individual or entity. | [optional] -**city** | **str** | The city of the address. | [optional] -**state** | **str** | The state of the address. | [optional] -**zip** | **str** | The ZIP code of the address. | [optional] +**city** | **str** | The city of the address. | +**state** | **str** | The state of the address. | +**zip** | **str** | The ZIP code of the address. | **account_number** | **str** | The account number associated with the form. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] -**tin** | **str** | The taxpayer identification number (TIN). | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. SSN/ITIN (for individuals) and EIN (for businesses). | +**tin** | **str** | The taxpayer identification number (TIN). | **backup_withholding** | **bool** | Indicates whether backup withholding applies. | [optional] **is1099able** | **bool** | Indicates whether the individual or entity should be issued a 1099 form. | [optional] **e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] **signature** | **str** | The signature of the form. | [optional] -**company_id** | **str** | The ID of the associated company. | +**company_id** | **str** | The ID of the associated company. Required when creating a form. | [optional] **reference_id** | **str** | A reference identifier for the form. | [optional] **email** | **str** | The email address of the individual associated with the form. | [optional] diff --git a/docs/A1099/V2/W9FormResponse.md b/docs/A1099/V2/W9FormResponse.md index 0a0fb46..409264a 100644 --- a/docs/A1099/V2/W9FormResponse.md +++ b/docs/A1099/V2/W9FormResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | The form type (always \"W9\" for this model). | [optional] [readonly] **name** | **str** | The name of the individual or entity associated with the form. | [optional] **business_name** | **str** | The name of the business associated with the form. | [optional] **business_classification** | **str** | The classification of the business. | [optional] @@ -19,11 +20,24 @@ Name | Type | Description | Notes **state** | **str** | The state of the address. | [optional] **zip** | **str** | The ZIP code of the address. | [optional] **account_number** | **str** | The account number associated with the form. | [optional] -**tin_type** | **str** | The type of TIN provided. | [optional] +**tin_type** | **str** | Tax Identification Number (TIN) type. | [optional] **tin** | **str** | The taxpayer identification number (TIN). | [optional] **backup_withholding** | **bool** | Indicates whether backup withholding applies. | [optional] **is1099able** | **bool** | Indicates whether the individual or entity should be issued a 1099 form. | [optional] **tin_match_status** | [**TinMatchStatusResponse**](TinMatchStatusResponse.md) | The TIN Match status from IRS. | [optional] +**id** | **str** | The unique identifier for the form. | [optional] +**entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] +**reference_id** | **str** | A reference identifier for the form. | [optional] +**company_id** | **str** | The ID of the associated company. | [optional] +**display_name** | **str** | The display name associated with the form. | [optional] +**email** | **str** | The email address of the individual associated with the form. | [optional] +**archived** | **bool** | Indicates whether the form is archived. | [optional] +**ancestor_id** | **str** | Form ID of previous version. | [optional] +**signature** | **str** | The signature of the form. | [optional] +**signed_date** | **datetime** | The date the form was signed. | [optional] +**e_delivery_consented_at** | **datetime** | The date when e-delivery was consented. | [optional] +**created_at** | **datetime** | The creation date of the form. | [optional] +**updated_at** | **datetime** | The last updated date of the form. | [optional] ## Example diff --git a/setup.py b/setup.py index 4a2505a..d7aeea5 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.8.3 +@version 25.9.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -40,7 +40,7 @@ from setuptools import setup, find_namespace_packages NAME = "Avalara.SDK" -VERSION = "25.8.3" +VERSION = "25.9.0" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0",