From 680e72e014de8fdd986b34574096ee2608c2b76b Mon Sep 17 00:00:00 2001 From: "svc.developer" Date: Fri, 19 Sep 2025 10:08:20 -0700 Subject: [PATCH 1/3] Update header logic --- lib/avalara_sdk/api_client.rb | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/lib/avalara_sdk/api_client.rb b/lib/avalara_sdk/api_client.rb index 99e3ab8..ea649dd 100644 --- a/lib/avalara_sdk/api_client.rb +++ b/lib/avalara_sdk/api_client.rb @@ -135,8 +135,16 @@ def build_request(http_method, path, request, opts = {}) relative_url = build_request_url(path).sub(%r{^/}, '') header_params = @default_headers.merge(opts[:header_params] || {}) - header_params['X-Avalara-Client'] = - "#{@config.app_name};#{@config.app_version};RubySdk;#{@sdk_version};#{@config.machine_name}" + + sdk_client_header = "#{@config.app_name};#{@config.app_version};RubySdk;#{@sdk_version};#{@config.machine_name}" + + # Always set X-Avalara-SDK-Client to SDK info + header_params['X-Avalara-SDK-Client'] = sdk_client_header + + # If X-Avalara-Client is null/empty, set it to SDK info as well + if header_params['X-Avalara-Client'].nil? || header_params['X-Avalara-Client'].empty? + header_params['X-Avalara-Client'] = sdk_client_header + end query_params = opts[:query_params] || {} form_params = opts[:form_params] || {} From a965cc748583ccdf8107fb9d5bc942ab91b54777 Mon Sep 17 00:00:00 2001 From: "svc.developer" Date: Fri, 19 Sep 2025 10:52:29 -0700 Subject: [PATCH 2/3] 25.9.0 --- README.md | 18 +- docs/A1099/V2/CompaniesW9Api.md | 18 +- docs/A1099/V2/CompanyBase.md | 50 +++ docs/A1099/V2/CompanyRequest.md | 50 +++ docs/A1099/V2/Form1042S.md | 32 +- docs/A1099/V2/Form1095B.md | 30 +- docs/A1099/V2/Form1095C.md | 28 +- docs/A1099/V2/Form1099Base.md | 28 +- docs/A1099/V2/Form1099Div.md | 30 +- docs/A1099/V2/Form1099Int.md | 32 +- docs/A1099/V2/Form1099K.md | 40 +- docs/A1099/V2/Form1099ListRequest.md | 2 +- docs/A1099/V2/Form1099Misc.md | 30 +- docs/A1099/V2/Form1099Nec.md | 34 +- docs/A1099/V2/Form1099R.md | 34 +- docs/A1099/V2/Forms1099Api.md | 24 +- docs/A1099/V2/FormsW9Api.md | 34 +- docs/A1099/V2/IntermediaryOrFlowThrough.md | 4 +- docs/A1099/V2/IssuerBase.md | 46 ++ docs/A1099/V2/IssuerRequest.md | 46 ++ docs/A1099/V2/Issuers1099Api.md | 18 +- docs/A1099/V2/JobResponse.md | 2 +- docs/A1099/V2/JobsApi.md | 2 +- docs/A1099/V2/TinMatchStatusResponse.md | 2 +- docs/A1099/V2/W4FormMinimalRequest.md | 4 +- docs/A1099/V2/W4FormRequest.md | 22 +- docs/A1099/V2/W4FormResponse.md | 68 ++- docs/A1099/V2/W8BenEFormMinimalRequest.md | 4 +- docs/A1099/V2/W8BenEFormRequest.md | 20 +- docs/A1099/V2/W8BenEFormResponse.md | 164 ++++--- docs/A1099/V2/W8BenFormMinimalRequest.md | 4 +- docs/A1099/V2/W8BenFormRequest.md | 12 +- docs/A1099/V2/W8BenFormResponse.md | 82 ++-- docs/A1099/V2/W8ImyFormMinimalRequest.md | 4 +- docs/A1099/V2/W8ImyFormRequest.md | 20 +- docs/A1099/V2/W8ImyFormResponse.md | 208 +++++---- docs/A1099/V2/W9FormBaseMinimalRequest.md | 4 +- docs/A1099/V2/W9FormBaseRequest.md | 4 +- docs/A1099/V2/W9FormBaseResponse.md | 6 +- docs/A1099/V2/W9FormMinimalRequest.md | 4 +- docs/A1099/V2/W9FormRequest.md | 20 +- docs/A1099/V2/W9FormResponse.md | 60 ++- lib/avalara_sdk.rb | 12 +- .../api/A1099/V2/companies_w9_api.rb | 42 +- lib/avalara_sdk/api/A1099/V2/forms1099_api.rb | 14 +- lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb | 32 +- .../api/A1099/V2/issuers1099_api.rb | 42 +- lib/avalara_sdk/api/A1099/V2/jobs_api.rb | 2 +- .../EInvoicing/V1/data_input_fields_api.rb | 2 +- .../api/EInvoicing/V1/documents_api.rb | 2 +- .../api/EInvoicing/V1/interop_api.rb | 2 +- .../api/EInvoicing/V1/mandates_api.rb | 2 +- .../api/EInvoicing/V1/subscriptions_api.rb | 2 +- .../api/EInvoicing/V1/tax_identifiers_api.rb | 2 +- .../api/EInvoicing/V1/trading_partners_api.rb | 2 +- .../models/A1099/V2/company_base.rb | 404 +++++++++++++++++ .../models/A1099/V2/company_request.rb | 411 ++++++++++++++++++ .../models/A1099/V2/company_response.rb | 2 +- .../models/A1099/V2/error_response.rb | 6 - lib/avalara_sdk/models/A1099/V2/form1042_s.rb | 50 +-- lib/avalara_sdk/models/A1099/V2/form1095_b.rb | 59 +-- lib/avalara_sdk/models/A1099/V2/form1095_c.rb | 67 +-- .../models/A1099/V2/form1099_base.rb | 47 +- .../models/A1099/V2/form1099_div.rb | 51 +-- .../models/A1099/V2/form1099_int.rb | 54 +-- lib/avalara_sdk/models/A1099/V2/form1099_k.rb | 73 ++-- .../models/A1099/V2/form1099_list_request.rb | 14 +- .../models/A1099/V2/form1099_misc.rb | 51 +-- .../models/A1099/V2/form1099_nec.rb | 56 +-- lib/avalara_sdk/models/A1099/V2/form1099_r.rb | 81 ++-- .../A1099/V2/intermediary_or_flow_through.rb | 50 ++- .../models/A1099/V2/issuer_base.rb | 384 ++++++++++++++++ .../models/A1099/V2/issuer_request.rb | 391 +++++++++++++++++ .../models/A1099/V2/issuer_response.rb | 2 +- .../models/A1099/V2/job_response.rb | 6 - .../models/A1099/V2/validation_error.rb | 6 - .../A1099/V2/w4_form_minimal_request.rb | 28 +- .../models/A1099/V2/w4_form_request.rb | 60 +-- .../models/A1099/V2/w4_form_response.rb | 206 ++++++++- .../A1099/V2/w8_ben_e_form_minimal_request.rb | 28 +- .../models/A1099/V2/w8_ben_e_form_request.rb | 65 +-- .../models/A1099/V2/w8_ben_e_form_response.rb | 204 ++++++++- .../A1099/V2/w8_ben_form_minimal_request.rb | 28 +- .../models/A1099/V2/w8_ben_form_request.rb | 43 +- .../models/A1099/V2/w8_ben_form_response.rb | 206 ++++++++- .../A1099/V2/w8_imy_form_minimal_request.rb | 28 +- .../models/A1099/V2/w8_imy_form_request.rb | 58 +-- .../models/A1099/V2/w8_imy_form_response.rb | 206 ++++++++- .../A1099/V2/w9_form_base_minimal_request.rb | 28 +- .../models/A1099/V2/w9_form_base_request.rb | 28 +- .../models/A1099/V2/w9_form_base_response.rb | 65 ++- .../A1099/V2/w9_form_minimal_request.rb | 28 +- .../models/A1099/V2/w9_form_request.rb | 65 +-- .../models/A1099/V2/w9_form_response.rb | 204 ++++++++- 94 files changed, 3964 insertions(+), 1381 deletions(-) create mode 100644 docs/A1099/V2/CompanyBase.md create mode 100644 docs/A1099/V2/CompanyRequest.md create mode 100644 docs/A1099/V2/IssuerBase.md create mode 100644 docs/A1099/V2/IssuerRequest.md create mode 100644 lib/avalara_sdk/models/A1099/V2/company_base.rb create mode 100644 lib/avalara_sdk/models/A1099/V2/company_request.rb create mode 100644 lib/avalara_sdk/models/A1099/V2/issuer_base.rb create mode 100644 lib/avalara_sdk/models/A1099/V2/issuer_request.rb diff --git a/README.md b/README.md index 23a0618..c5e8c3c 100644 --- a/README.md +++ b/README.md @@ -190,18 +190,14 @@ Class | Method | HTTP request | Description ### A1099 V2 Model Documentation - - [models.AuthorizedApiRequestModel](docs/A1099/V2/AuthorizedApiRequestModel.md) - - [models.AuthorizedApiRequestV2DataModel](docs/A1099/V2/AuthorizedApiRequestV2DataModel.md) - - [models.CompanyCreateUpdateRequestModel](docs/A1099/V2/CompanyCreateUpdateRequestModel.md) + - [models.CompanyBase](docs/A1099/V2/CompanyBase.md) + - [models.CompanyRequest](docs/A1099/V2/CompanyRequest.md) - [models.CompanyResponse](docs/A1099/V2/CompanyResponse.md) - [models.CoveredIndividual](docs/A1099/V2/CoveredIndividual.md) - [models.CreateAndSendW9FormEmailRequest](docs/A1099/V2/CreateAndSendW9FormEmailRequest.md) - - [models.CreateCompanyRequest](docs/A1099/V2/CreateCompanyRequest.md) - - [models.CreateIssuerRequest](docs/A1099/V2/CreateIssuerRequest.md) - [models.CreateW9Form201Response](docs/A1099/V2/CreateW9Form201Response.md) - [models.CreateW9FormRequest](docs/A1099/V2/CreateW9FormRequest.md) - [models.EntryStatusResponse](docs/A1099/V2/EntryStatusResponse.md) - - [models.ErrorModel](docs/A1099/V2/ErrorModel.md) - [models.ErrorResponse](docs/A1099/V2/ErrorResponse.md) - [models.ErrorResponseItem](docs/A1099/V2/ErrorResponseItem.md) - [models.Form1042S](docs/A1099/V2/Form1042S.md) @@ -217,10 +213,10 @@ Class | Method | HTTP request | Description - [models.Form1099R](docs/A1099/V2/Form1099R.md) - [models.Form1099StatusDetail](docs/A1099/V2/Form1099StatusDetail.md) - [models.Get1099Form200Response](docs/A1099/V2/Get1099Form200Response.md) - - [models.IW9FormDataModelsOneOf](docs/A1099/V2/IW9FormDataModelsOneOf.md) - [models.IntermediaryOrFlowThrough](docs/A1099/V2/IntermediaryOrFlowThrough.md) - [models.IrsResponse](docs/A1099/V2/IrsResponse.md) - - [models.IssuerCommand](docs/A1099/V2/IssuerCommand.md) + - [models.IssuerBase](docs/A1099/V2/IssuerBase.md) + - [models.IssuerRequest](docs/A1099/V2/IssuerRequest.md) - [models.IssuerResponse](docs/A1099/V2/IssuerResponse.md) - [models.JobResponse](docs/A1099/V2/JobResponse.md) - [models.OfferAndCoverage](docs/A1099/V2/OfferAndCoverage.md) @@ -235,27 +231,21 @@ Class | Method | HTTP request | Description - [models.SubstantialUsOwnerResponse](docs/A1099/V2/SubstantialUsOwnerResponse.md) - [models.TinMatchStatusResponse](docs/A1099/V2/TinMatchStatusResponse.md) - [models.ValidationError](docs/A1099/V2/ValidationError.md) - - [models.W4FormDataModel](docs/A1099/V2/W4FormDataModel.md) - [models.W4FormMinimalRequest](docs/A1099/V2/W4FormMinimalRequest.md) - [models.W4FormRequest](docs/A1099/V2/W4FormRequest.md) - [models.W4FormResponse](docs/A1099/V2/W4FormResponse.md) - [models.W8BenEFormMinimalRequest](docs/A1099/V2/W8BenEFormMinimalRequest.md) - [models.W8BenEFormRequest](docs/A1099/V2/W8BenEFormRequest.md) - [models.W8BenEFormResponse](docs/A1099/V2/W8BenEFormResponse.md) - - [models.W8BenESubstantialUsOwnerDataModel](docs/A1099/V2/W8BenESubstantialUsOwnerDataModel.md) - - [models.W8BenFormDataModel](docs/A1099/V2/W8BenFormDataModel.md) - [models.W8BenFormMinimalRequest](docs/A1099/V2/W8BenFormMinimalRequest.md) - [models.W8BenFormRequest](docs/A1099/V2/W8BenFormRequest.md) - [models.W8BenFormResponse](docs/A1099/V2/W8BenFormResponse.md) - - [models.W8BeneFormDataModel](docs/A1099/V2/W8BeneFormDataModel.md) - - [models.W8ImyFormDataModel](docs/A1099/V2/W8ImyFormDataModel.md) - [models.W8ImyFormMinimalRequest](docs/A1099/V2/W8ImyFormMinimalRequest.md) - [models.W8ImyFormRequest](docs/A1099/V2/W8ImyFormRequest.md) - [models.W8ImyFormResponse](docs/A1099/V2/W8ImyFormResponse.md) - [models.W9FormBaseMinimalRequest](docs/A1099/V2/W9FormBaseMinimalRequest.md) - [models.W9FormBaseRequest](docs/A1099/V2/W9FormBaseRequest.md) - [models.W9FormBaseResponse](docs/A1099/V2/W9FormBaseResponse.md) - - [models.W9FormDataModel](docs/A1099/V2/W9FormDataModel.md) - [models.W9FormMinimalRequest](docs/A1099/V2/W9FormMinimalRequest.md) - [models.W9FormRequest](docs/A1099/V2/W9FormRequest.md) - [models.W9FormResponse](docs/A1099/V2/W9FormResponse.md) diff --git a/docs/A1099/V2/CompaniesW9Api.md b/docs/A1099/V2/CompaniesW9Api.md index 2ca9f2b..ca1bc34 100644 --- a/docs/A1099/V2/CompaniesW9Api.md +++ b/docs/A1099/V2/CompaniesW9Api.md @@ -39,9 +39,9 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '68cce84c-ae6e-4cef-bdc6-4620c710b5e5', # String | Unique correlation Id in a GUID format + x_correlation_id: 'a607ad38-398e-43d2-918d-d809e43dbd6b', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - create_company_request: AvalaraSdk::A1099::V2::CompanyCreateUpdateRequestModel.new({name: 'name_example', email: 'email_example', address: 'address_example', city: 'city_example', zip: 'zip_example', telephone: 'telephone_example', tin: 'tin_example', country_code: 'country_code_example'}) # CreateCompanyRequest | The company to create + company_request: AvalaraSdk::A1099::V2::CompanyRequest.new({name: 'name_example', email: 'email_example', address: 'address_example', city: 'city_example', zip: 'zip_example', telephone: 'telephone_example', tin: 'tin_example', country_code: 'country_code_example'}) # CompanyRequest | The company to create } begin @@ -78,7 +78,7 @@ end | **avalara_version** | **String** | API version | | | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] | | **x_avalara_client** | **String** | 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 @@ -123,7 +123,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client id = 'id_example' # String | The company to delete avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'f2e08ea9-6e1e-4828-91f9-4926ff26dbe4', # String | Unique correlation Id in a GUID format + x_correlation_id: '54780530-dee1-472f-8626-a1ef1d6f3bfa', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -210,7 +210,7 @@ opts = { order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. count: true, # Boolean | If true, return the global count of elements in the collection. count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true. - x_correlation_id: 'f431c7bb-9661-447a-8f5f-b17b3d55a06c', # String | Unique correlation Id in a GUID format + x_correlation_id: '7ee6e06e-ae28-4317-9053-d966f0b24a94', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -298,7 +298,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client id = 'id_example' # String | Id of the company avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'c5c11797-5ea9-4ec3-85ba-ed4e0ee63300', # String | Unique correlation Id in a GUID format + x_correlation_id: 'c2254966-bcae-4b32-a7b4-67f0518ca748', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -381,9 +381,9 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client id = 'id_example' # String | The ID of the company to update avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '86a26d78-90b6-4ca0-a10b-0221d11dd34a', # String | Unique correlation Id in a GUID format + x_correlation_id: 'b730ea19-59f4-4cc8-8ef0-94a9d4637a6a', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - create_company_request: AvalaraSdk::A1099::V2::CompanyCreateUpdateRequestModel.new({name: 'name_example', email: 'email_example', address: 'address_example', city: 'city_example', zip: 'zip_example', telephone: 'telephone_example', tin: 'tin_example', country_code: 'country_code_example'}) # CreateCompanyRequest | The updated company data + company_request: AvalaraSdk::A1099::V2::CompanyRequest.new({name: 'name_example', email: 'email_example', address: 'address_example', city: 'city_example', zip: 'zip_example', telephone: 'telephone_example', tin: 'tin_example', country_code: 'country_code_example'}) # CompanyRequest | The updated company data } begin @@ -421,7 +421,7 @@ end | **avalara_version** | **String** | API version | | | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] | | **x_avalara_client** | **String** | 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..bbcdd86 --- /dev/null +++ b/docs/A1099/V2/CompanyBase.md @@ -0,0 +1,50 @@ +# AvalaraSdk::A1099::V2::CompanyBase + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **name** | **String** | Legal name. Not the DBA name. | | +| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. | [optional] | +| **email** | **String** | Contact email address. For inquiries by vendors/employees. | | +| **address** | **String** | Address. | | +| **city** | **String** | City. | | +| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional] | +| **zip** | **String** | ZIP/postal code. | | +| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). | | +| **tin** | **String** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). | | +| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | +| **do_tin_match** | **Boolean** | Indicates whether the company authorizes IRS TIN matching. | [optional] | +| **group_name** | **String** | Group name for organizing companies (creates or finds group by name). | [optional] | +| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] | +| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | | +| **resend_requests** | **Boolean** | Boolean to enable automatic reminder emails (default: false). | [optional] | +| **resend_interval_days** | **Integer** | Days between reminder emails (7-365, required if resendRequests is true). | [optional] | +| **max_reminder_attempts** | **Integer** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional] | + +## Example + +```ruby +require 'avalara_sdk' + +instance = AvalaraSdk::A1099::V2::CompanyBase.new( + name: null, + dba_name: null, + email: null, + address: null, + city: null, + state: null, + zip: null, + telephone: null, + tin: null, + reference_id: null, + do_tin_match: null, + group_name: null, + foreign_province: null, + country_code: null, + resend_requests: null, + resend_interval_days: null, + max_reminder_attempts: null +) +``` + diff --git a/docs/A1099/V2/CompanyRequest.md b/docs/A1099/V2/CompanyRequest.md new file mode 100644 index 0000000..15e061f --- /dev/null +++ b/docs/A1099/V2/CompanyRequest.md @@ -0,0 +1,50 @@ +# AvalaraSdk::A1099::V2::CompanyRequest + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **name** | **String** | Legal name. Not the DBA name. | | +| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. | [optional] | +| **email** | **String** | Contact email address. For inquiries by vendors/employees. | | +| **address** | **String** | Address. | | +| **city** | **String** | City. | | +| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional] | +| **zip** | **String** | ZIP/postal code. | | +| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). | | +| **tin** | **String** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). | | +| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | +| **do_tin_match** | **Boolean** | Indicates whether the company authorizes IRS TIN matching. | [optional] | +| **group_name** | **String** | Group name for organizing companies (creates or finds group by name). | [optional] | +| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] | +| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | | +| **resend_requests** | **Boolean** | Boolean to enable automatic reminder emails (default: false). | [optional] | +| **resend_interval_days** | **Integer** | Days between reminder emails (7-365, required if resendRequests is true). | [optional] | +| **max_reminder_attempts** | **Integer** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional] | + +## Example + +```ruby +require 'avalara_sdk' + +instance = AvalaraSdk::A1099::V2::CompanyRequest.new( + name: null, + dba_name: null, + email: null, + address: null, + city: null, + state: null, + zip: null, + telephone: null, + tin: null, + reference_id: null, + do_tin_match: null, + group_name: null, + foreign_province: null, + country_code: null, + resend_requests: null, + resend_interval_days: null, + max_reminder_attempts: null +) +``` + diff --git a/docs/A1099/V2/Form1042S.md b/docs/A1099/V2/Form1042S.md index afd4ec4..9fff523 100644 --- a/docs/A1099/V2/Form1042S.md +++ b/docs/A1099/V2/Form1042S.md @@ -4,7 +4,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **tin_type** | **String** | | [optional][readonly] | +| **tin_type** | **String** | 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** | **String** | Unique form identifier | | | **recipient_date_of_birth** | **Date** | Recipient's date of birth | [optional] | | **recipient_giin** | **String** | Recipient's Global Intermediary Identification Number (GIIN). A valid GIIN looks like 'XXXXXX.XXXXX.XX.XXX'. | [optional] | @@ -24,16 +24,16 @@ | **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** | **String** | 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** | **String** | 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** | **String** | 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** | **String** | 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** | **String** | Form type | | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | @@ -48,21 +48,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -97,7 +97,7 @@ instance = AvalaraSdk::A1099::V2::Form1042S.new( chap4_status_code: null, primary_withholding_agent: null, intermediary_or_flow_through: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1095B.md b/docs/A1099/V2/Form1095B.md index 5007b63..b79ba09 100644 --- a/docs/A1099/V2/Form1095B.md +++ b/docs/A1099/V2/Form1095B.md @@ -9,18 +9,18 @@ | **employee_last_name** | **String** | Employee's last name | | | **employee_name_suffix** | **String** | Employee's name suffix | [optional] | | **employee_date_of_birth** | **Date** | Employee's date of birth | [optional] | -| **origin_of_health_coverage_code** | **String** | 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** | **String** | 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** | [**Array<CoveredIndividual>**](CoveredIndividual.md) | Covered individuals information - At least one month of coverage must be entered if it's not a correction. | [optional] | -| **type** | **String** | Form type | | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -32,21 +32,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -64,7 +64,7 @@ instance = AvalaraSdk::A1099::V2::Form1095B.new( employee_date_of_birth: null, origin_of_health_coverage_code: null, covered_individuals: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1095C.md b/docs/A1099/V2/Form1095C.md index 15199d6..1569eaa 100644 --- a/docs/A1099/V2/Form1095C.md +++ b/docs/A1099/V2/Form1095C.md @@ -13,16 +13,16 @@ | **employer_provided_si_coverage** | **Boolean** | Employer provided self-insured coverage | [optional] | | **offer_and_coverages** | [**Array<OfferAndCoverage>**](OfferAndCoverage.md) | Offer and coverage information | | | **covered_individuals** | [**Array<CoveredIndividual>**](CoveredIndividual.md) | Covered individuals information | [optional] | -| **type** | **String** | Form type | | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -34,21 +34,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -68,7 +68,7 @@ instance = AvalaraSdk::A1099::V2::Form1095C.new( employer_provided_si_coverage: null, offer_and_coverages: null, covered_individuals: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1099Base.md b/docs/A1099/V2/Form1099Base.md index ecd77c5..08e977f 100644 --- a/docs/A1099/V2/Form1099Base.md +++ b/docs/A1099/V2/Form1099Base.md @@ -4,16 +4,16 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **type** | **String** | Form type | | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -25,21 +25,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -50,7 +50,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::Form1099Base.new( - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1099Div.md b/docs/A1099/V2/Form1099Div.md index 05836f8..20ae963 100644 --- a/docs/A1099/V2/Form1099Div.md +++ b/docs/A1099/V2/Form1099Div.md @@ -22,17 +22,17 @@ | **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** | **Boolean** | FATCA filing requirement | [optional] | -| **type** | **String** | Form type | | +| **fatca_filing_requirement** | **Boolean** | FATCA filing requirement. | [optional] | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -44,21 +44,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -88,7 +88,7 @@ instance = AvalaraSdk::A1099::V2::Form1099Div.new( exempt_interest_dividends: null, specified_private_activity_bond_interest_dividends: null, fatca_filing_requirement: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1099Int.md b/docs/A1099/V2/Form1099Int.md index 4d8002d..2604257 100644 --- a/docs/A1099/V2/Form1099Int.md +++ b/docs/A1099/V2/Form1099Int.md @@ -17,18 +17,18 @@ | **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** | **String** | Tax exempt bond CUSIP no. | [optional] | -| **fatca_filing_requirement** | **Boolean** | FATCA filing requirement | [optional] | -| **type** | **String** | Form type | | +| **tax_exempt_bond_cusip_number** | **String** | 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** | **Boolean** | FATCA filing requirement. | [optional] | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -40,21 +40,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -80,7 +80,7 @@ instance = AvalaraSdk::A1099::V2::Form1099Int.new( bond_premium_on_tax_exempt_bond: null, tax_exempt_bond_cusip_number: null, fatca_filing_requirement: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1099K.md b/docs/A1099/V2/Form1099K.md index 0bd72d0..1543a95 100644 --- a/docs/A1099/V2/Form1099K.md +++ b/docs/A1099/V2/Form1099K.md @@ -4,13 +4,13 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **filer_type** | **String** | Filer type (PSE or EPF) | [optional] | -| **payment_type** | **String** | Payment type (payment card or third party network) | [optional] | -| **payment_settlement_entity_name_phone_number** | **String** | 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** | **String** | Filer type for tax reporting purposes. Available values: - PSE: Payment Settlement Entity - EPF: Electronic Payment Facilitator or other third party | | +| **payment_type** | **String** | Payment type for transaction classification. Available values: - PaymentCard: Payment card transactions - ThirdPartyNetwork: Third party network transactions | | +| **payment_settlement_entity_name_phone_number** | **String** | 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** | **String** | Merchant category code | [optional] | -| **payment_transaction_number** | **Float** | Number of payment transactions | [optional] | +| **merchant_category_code** | **String** | 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] | @@ -24,16 +24,16 @@ | **october** | **Float** | October gross payments | [optional] | | **november** | **Float** | November gross payments | [optional] | | **december** | **Float** | December gross payments | [optional] | -| **type** | **String** | Form type | | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -45,21 +45,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -90,7 +90,7 @@ instance = AvalaraSdk::A1099::V2::Form1099K.new( october: null, november: null, december: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1099ListRequest.md b/docs/A1099/V2/Form1099ListRequest.md index 225620c..f9ef5b8 100644 --- a/docs/A1099/V2/Form1099ListRequest.md +++ b/docs/A1099/V2/Form1099ListRequest.md @@ -13,7 +13,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::Form1099ListRequest.new( - type: 1099-NEC, + type: null, forms: null ) ``` diff --git a/docs/A1099/V2/Form1099Misc.md b/docs/A1099/V2/Form1099Misc.md index bbaaed2..c3f7e69 100644 --- a/docs/A1099/V2/Form1099Misc.md +++ b/docs/A1099/V2/Form1099Misc.md @@ -18,17 +18,17 @@ | **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** | **Boolean** | FATCA filing requirement | [optional] | -| **type** | **String** | Form type | | +| **fatca_filing_requirement** | **Boolean** | FATCA filing requirement. | [optional] | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -40,21 +40,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -80,7 +80,7 @@ instance = AvalaraSdk::A1099::V2::Form1099Misc.new( excess_golden_parachute_payments: null, nonqualified_deferred_compensation: null, fatca_filing_requirement: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1099Nec.md b/docs/A1099/V2/Form1099Nec.md index f22251b..11e0a82 100644 --- a/docs/A1099/V2/Form1099Nec.md +++ b/docs/A1099/V2/Form1099Nec.md @@ -4,19 +4,19 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **nonemployee_compensation** | **Float** | Nonemployee compensation | | -| **direct_sales_indicator** | **Boolean** | 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** | **String** | Form type | | +| **nonemployee_compensation** | **Float** | Nonemployee compensation. Required if DirectSalesIndicator is false. | | +| **direct_sales_indicator** | **Boolean** | 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** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -28,21 +28,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -56,7 +56,7 @@ instance = AvalaraSdk::A1099::V2::Form1099Nec.new( nonemployee_compensation: null, direct_sales_indicator: null, federal_income_tax_withheld: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Form1099R.md b/docs/A1099/V2/Form1099R.md index 564d420..fe9dc23 100644 --- a/docs/A1099/V2/Form1099R.md +++ b/docs/A1099/V2/Form1099R.md @@ -12,8 +12,8 @@ | **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** | **String** | Distribution code | [optional] | -| **second_distribution_code** | **String** | Second distribution code | [optional] | +| **distribution_code** | **String** | 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** | **String** | 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** | **Boolean** | 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] | @@ -23,17 +23,17 @@ | **amount_allocable_to_irr_within5_years** | **Float** | Amount allocable to IRR within 5 years | [optional] | | **first_year_of_designated_roth_contribution** | **String** | First year of designated Roth contribution | [optional] | | **date_of_payment** | **Date** | Date of payment | [optional] | -| **fatca_filing_requirement** | **Boolean** | FATCA filing requirement | [optional] | -| **type** | **String** | Form type | | +| **fatca_filing_requirement** | **Boolean** | FATCA filing requirement. | [optional] | +| **type** | **String** | Form type. | | | **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] | | **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] | -| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] | +| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] | | **issuer_tin** | **String** | Issuer TIN - readonly | [optional] | -| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] | +| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] | | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] | | **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] | | **recipient_name** | **String** | Recipient name | | -| **tin_type** | **String** | Type of TIN (Tax ID Number) | [optional] | +| **tin_type** | **String** | 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** | **String** | Recipient second name | [optional] | | **address** | **String** | Address. | | | **address2** | **String** | Address line 2. | [optional] | @@ -45,21 +45,21 @@ | **office_code** | **String** | Office code | [optional] | | **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] | | **country_code** | **String** | 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** | **Boolean** | 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** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] | | **no_tin** | **Boolean** | No TIN indicator | [optional] | | **address_verification** | **Boolean** | 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** | **Boolean** | Second TIN notice | [optional] | -| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] | -| **state_efile_status** | [**Array<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** | [**Array<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** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] | | **created_at** | **Time** | Date time when the record was created. | [optional][readonly] | | **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] | @@ -90,7 +90,7 @@ instance = AvalaraSdk::A1099::V2::Form1099R.new( first_year_of_designated_roth_contribution: null, date_of_payment: null, fatca_filing_requirement: null, - type: 1099-NEC, + type: null, id: null, issuer_id: null, issuer_reference_id: null, diff --git a/docs/A1099/V2/Forms1099Api.md b/docs/A1099/V2/Forms1099Api.md index 54e379c..9dd0940 100644 --- a/docs/A1099/V2/Forms1099Api.md +++ b/docs/A1099/V2/Forms1099Api.md @@ -19,7 +19,7 @@ All URIs are relative to *https://api.sbx.avalara.com/avalara1099* 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. ### Examples @@ -42,7 +42,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client avalara_version = '2.0.0' # String | API version opts = { dry_run: true, # Boolean | 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 - x_correlation_id: '16e56e1f-e623-4f23-9904-21c29b5b4545', # String | Unique correlation Id in a GUID format + x_correlation_id: '5ef65de0-c394-4aa2-b249-d8bfcbe9b23a', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . form1099_list_request: AvalaraSdk::A1099::V2::Form1099ListRequest.new # Form1099ListRequest | } @@ -104,7 +104,7 @@ end 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. ### Examples @@ -126,9 +126,9 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'e4a7bf40-da9f-452a-b2db-c8b64721610b', # String | Unique correlation Id in a GUID format + x_correlation_id: '5b55b569-4e1e-44d3-920c-65153461c426', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - get1099_form200_response: AvalaraSdk::A1099::V2::Form1042S.new({unique_form_id: 'unique_form_id_example', income_code: '01', gross_income: 3.56, withholding_indicator: '3', tax_country_code: 'tax_country_code_example', type: '1099-NEC', recipient_name: 'recipient_name_example', address: 'address_example', city: 'city_example', country_code: 'country_code_example'}) # Get1099Form200Response | + get1099_form200_response: AvalaraSdk::A1099::V2::Form1042S.new({unique_form_id: 'unique_form_id_example', income_code: '01', gross_income: 3.56, withholding_indicator: '3', tax_country_code: 'tax_country_code_example', type: 'Form1099Nec', recipient_name: 'recipient_name_example', address: 'address_example', city: 'city_example', country_code: 'country_code_example'}) # Get1099Form200Response | } begin @@ -210,7 +210,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client id = 'id_example' # String | The unique identifier of the desired form to delete. avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '8e01e950-8e1c-4b1b-9120-2e2452c6d590', # String | Unique correlation Id in a GUID format + x_correlation_id: 'e82ee14f-7146-41a5-b856-28f403d65e29', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -292,7 +292,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client id = 'id_example' # String | avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '7b8174a3-a873-4a05-a619-f362955f4608', # String | Unique correlation Id in a GUID format + x_correlation_id: 'f5198e72-fc87-4a4d-a09a-b2aa6cf70c38', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -376,7 +376,7 @@ id = 'id_example' # String | The ID of the form avalara_version = '2.0.0' # String | API version opts = { mark_edelivered: true, # Boolean | Optional boolean that if set indicates that the form should be marked as having been successfully edelivered - x_correlation_id: 'a4dd3a23-ae45-45a5-8612-75e2fe4c1f36', # String | Unique correlation Id in a GUID format + x_correlation_id: '7fdfd0b2-cebf-4f25-8a65-6dd03811e77d', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -465,7 +465,7 @@ opts = { order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. count: true, # Boolean | If true, return the global count of elements in the collection. count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true. - x_correlation_id: 'f808e46a-fc55-4dd7-960d-13c6ba8176f2', # String | Unique correlation Id in a GUID format + x_correlation_id: '97f7596c-99c0-4879-b47c-57df572a32c9', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -530,7 +530,7 @@ end 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. ### Examples @@ -553,9 +553,9 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client id = 'id_example' # String | avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '944ee583-b810-471c-852c-d3c6f8b93a4b', # String | Unique correlation Id in a GUID format + x_correlation_id: '560aa857-d5ba-484b-9375-a14e9e57d7a8', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - get1099_form200_response: AvalaraSdk::A1099::V2::Form1042S.new({unique_form_id: 'unique_form_id_example', income_code: '01', gross_income: 3.56, withholding_indicator: '3', tax_country_code: 'tax_country_code_example', type: '1099-NEC', recipient_name: 'recipient_name_example', address: 'address_example', city: 'city_example', country_code: 'country_code_example'}) # Get1099Form200Response | + get1099_form200_response: AvalaraSdk::A1099::V2::Form1042S.new({unique_form_id: 'unique_form_id_example', income_code: '01', gross_income: 3.56, withholding_indicator: '3', tax_country_code: 'tax_country_code_example', type: 'Form1099Nec', recipient_name: 'recipient_name_example', address: 'address_example', city: 'city_example', country_code: 'country_code_example'}) # Get1099Form200Response | } begin diff --git a/docs/A1099/V2/FormsW9Api.md b/docs/A1099/V2/FormsW9Api.md index 02f57f3..76a5f21 100644 --- a/docs/A1099/V2/FormsW9Api.md +++ b/docs/A1099/V2/FormsW9Api.md @@ -42,9 +42,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '876394c1-80f7-4f02-a857-3899965a96bf', # String | Unique correlation Id in a GUID format + x_correlation_id: '96f3173e-05e5-496d-b7a2-8f3c8711164f', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - create_and_send_w9_form_email_request: AvalaraSdk::A1099::V2::W4FormMinimalRequest.new({email: 'email_example', employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example', company_id: 'company_id_example'}) # CreateAndSendW9FormEmailRequest | Form to be created + create_and_send_w9_form_email_request: AvalaraSdk::A1099::V2::W4FormMinimalRequest.new({email: 'email_example', employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example'}) # CreateAndSendW9FormEmailRequest | Form to be created } begin @@ -125,9 +125,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '4f7d2a74-9904-4300-b8c4-d5eadabea39b', # String | Unique correlation Id in a GUID format + x_correlation_id: '4fef31cf-2985-471b-83bb-59b4bf4cee0e', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({company_id: 'company_id_example'}) # CreateW9FormRequest | Form to be created + create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example', tin_type: 'tin_type_example', tin: 'tin_example'}) # CreateW9FormRequest | Form to be created } begin @@ -209,7 +209,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client id = 'id_example' # String | ID of the form to delete avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '897b8ec0-bd1d-404b-b128-05268ad1823d', # String | Unique correlation Id in a GUID format + x_correlation_id: 'b1cd71dd-2fd3-483d-b611-0dd8306b5201', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -291,7 +291,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client id = 'id_example' # String | ID of the form avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '5aacb16c-2a0a-4896-a0d2-a121f2b5d1d8', # String | Unique correlation Id in a GUID format + x_correlation_id: '6d803604-fec0-4f42-9114-e77ddd25d823', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -379,7 +379,7 @@ opts = { order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. count: true, # Boolean | If true, return the global count of elements in the collection. count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true. - x_correlation_id: '779b71e3-fc48-49be-b680-e44e47b3d963', # String | Unique correlation Id in a GUID format + x_correlation_id: '5473c6dd-8986-4b62-b027-9a94c94f9401', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -444,7 +444,7 @@ end 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. ### Examples @@ -467,7 +467,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client id = 'id_example' # String | The ID of the W9/W4/W8 form. avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '8f5afdc6-9616-494f-940c-c66b87b43d27', # String | Unique correlation Id in a GUID format + x_correlation_id: '1204a47d-7c4d-4b63-8776-560f89e236e6', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -523,7 +523,7 @@ end ## update_w9_form -> update_w9_form(id, avalara_version, opts) +> update_w9_form(id, avalara_version, opts) Update a W9/W4/W8 form @@ -550,9 +550,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client id = 'id_example' # String | ID of the form to update avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'e0842c54-95c7-488a-882a-ce34cb46e87d', # String | Unique correlation Id in a GUID format + x_correlation_id: '2f240777-dd4f-4aaf-b4b6-fcb22df6de90', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - iw9_form_data_models_one_of: AvalaraSdk::A1099::V2::W4FormDataModel.new # IW9FormDataModelsOneOf | Form to be updated + create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example', tin_type: 'tin_type_example', tin: 'tin_example'}) # CreateW9FormRequest | Form to be updated } begin @@ -568,7 +568,7 @@ end This returns an Array which contains the response data, status code and headers. -> , Integer, Hash)> update_w9_form_with_http_info(id, avalara_version, opts) +> , Integer, Hash)> update_w9_form_with_http_info(id, avalara_version, opts) ```ruby begin @@ -576,7 +576,7 @@ begin data, status_code, headers = api_instance.update_w9_form_with_http_info(id, avalara_version, opts) p status_code # => 2xx p headers # => { ... } - p data # => + p data # => rescue AvalaraSdk::A1099::V2::ApiError => e puts "Error when calling FormsW9Api->update_w9_form_with_http_info: #{e}" end @@ -590,11 +590,11 @@ end | **avalara_version** | **String** | API version | | | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] | | **x_avalara_client** | **String** | 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 @@ -635,7 +635,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client id = 'id_example' # String | Id of the form avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'ba11f0c0-e9ed-4667-8137-0026b63b63cf', # String | Unique correlation Id in a GUID format + x_correlation_id: 'ba65d92c-2a2a-4b4e-9731-c7b385d7fb59', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . file: File.new('/path/to/some/file') # File | } diff --git a/docs/A1099/V2/IntermediaryOrFlowThrough.md b/docs/A1099/V2/IntermediaryOrFlowThrough.md index 218b1c0..736830e 100644 --- a/docs/A1099/V2/IntermediaryOrFlowThrough.md +++ b/docs/A1099/V2/IntermediaryOrFlowThrough.md @@ -5,8 +5,8 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **ein** | **String** | EIN (Employer Identification Number) of the intermediary or flow-through entity | [optional] | -| **chap3_status_code** | **String** | Chapter 3 status code for the intermediary or flow-through entity | [optional] | -| **chap4_status_code** | **String** | Chapter 4 status code for the intermediary or flow-through entity | [optional] | +| **chap3_status_code** | **String** | 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** | **String** | 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** | **String** | Name of the intermediary or flow-through entity | [optional] | | **giin** | **String** | GIIN (Global Intermediary Identification Number) of the intermediary or flow-through entity | [optional] | | **country_code** | **String** | 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..921a6c4 --- /dev/null +++ b/docs/A1099/V2/IssuerBase.md @@ -0,0 +1,46 @@ +# AvalaraSdk::A1099::V2::IssuerBase + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **name** | **String** | Legal name. Not the DBA name. | | +| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] | +| **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] | +| **reference_id** | **String** | 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** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. | | +| **tax_year** | **Integer** | 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** | **String** | 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** | **String** | Contact email address. For recipient inquiries. | | +| **address** | **String** | Address. | | +| **city** | **String** | City. | | +| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | | +| **zip** | **String** | ZIP/postal code. | | +| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] | +| **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] | +| **last_filing** | **Boolean** | Indicates if this is the issuer's final year filing. | | + +## Example + +```ruby +require 'avalara_sdk' + +instance = AvalaraSdk::A1099::V2::IssuerBase.new( + name: null, + dba_name: null, + tin: null, + reference_id: null, + telephone: null, + tax_year: null, + country_code: null, + email: null, + address: null, + city: null, + state: null, + zip: null, + foreign_province: null, + transfer_agent_name: null, + last_filing: null +) +``` + diff --git a/docs/A1099/V2/IssuerRequest.md b/docs/A1099/V2/IssuerRequest.md new file mode 100644 index 0000000..f688480 --- /dev/null +++ b/docs/A1099/V2/IssuerRequest.md @@ -0,0 +1,46 @@ +# AvalaraSdk::A1099::V2::IssuerRequest + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **name** | **String** | Legal name. Not the DBA name. | | +| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] | +| **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] | +| **reference_id** | **String** | 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** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. | | +| **tax_year** | **Integer** | 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** | **String** | 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** | **String** | Contact email address. For recipient inquiries. | | +| **address** | **String** | Address. | | +| **city** | **String** | City. | | +| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | | +| **zip** | **String** | ZIP/postal code. | | +| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] | +| **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] | +| **last_filing** | **Boolean** | Indicates if this is the issuer's final year filing. | | + +## Example + +```ruby +require 'avalara_sdk' + +instance = AvalaraSdk::A1099::V2::IssuerRequest.new( + name: null, + dba_name: null, + tin: null, + reference_id: null, + telephone: null, + tax_year: null, + country_code: null, + email: null, + address: null, + city: null, + state: null, + zip: null, + foreign_province: null, + transfer_agent_name: null, + last_filing: null +) +``` + diff --git a/docs/A1099/V2/Issuers1099Api.md b/docs/A1099/V2/Issuers1099Api.md index 9ee2c3c..c386473 100644 --- a/docs/A1099/V2/Issuers1099Api.md +++ b/docs/A1099/V2/Issuers1099Api.md @@ -39,9 +39,9 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: '26a8ae54-5655-49b3-b01a-f4203094a5ef', # String | Unique correlation Id in a GUID format + x_correlation_id: '5c70e4f3-3885-4757-84f3-86323c1af033', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - create_issuer_request: AvalaraSdk::A1099::V2::IssuerCommand.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # CreateIssuerRequest | The issuer to create + issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to create } begin @@ -78,7 +78,7 @@ end | **avalara_version** | **String** | API version | | | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] | | **x_avalara_client** | **String** | 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 @@ -123,7 +123,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client id = 'id_example' # String | Id of the issuer to delete avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'b8d102b3-3e63-4e6e-9735-25f17b0c69a7', # String | Unique correlation Id in a GUID format + x_correlation_id: 'ebe59aa0-745c-44da-b86b-67ad7994619c', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -205,7 +205,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client id = 'id_example' # String | Id of the issuer to retrieve avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'fc90ea70-0e20-46ed-a73c-80e99e89f3d5', # String | Unique correlation Id in a GUID format + x_correlation_id: 'cfc604e9-15ae-4c65-a59f-123475fad2ef', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -293,7 +293,7 @@ opts = { order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. count: true, # Boolean | If true, return the global count of elements in the collection. count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true. - x_correlation_id: '8c33cfd6-f102-4192-9001-24fed7baee29', # String | Unique correlation Id in a GUID format + x_correlation_id: '3302a30f-61fc-4b94-af04-c683c6064eed', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } @@ -381,9 +381,9 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client id = 'id_example' # String | Id of the issuer to update avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'c353a7ba-0386-49f8-97a8-378cd39452ea', # String | Unique correlation Id in a GUID format + x_correlation_id: '4f30c58e-f8fd-4635-99d4-ea710f1d0182', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0', # String | 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/) . - create_issuer_request: AvalaraSdk::A1099::V2::IssuerCommand.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # CreateIssuerRequest | The issuer to update + issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to update } begin @@ -420,7 +420,7 @@ end | **avalara_version** | **String** | API version | | | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] | | **x_avalara_client** | **String** | 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/JobResponse.md b/docs/A1099/V2/JobResponse.md index 24dc158..e5be963 100644 --- a/docs/A1099/V2/JobResponse.md +++ b/docs/A1099/V2/JobResponse.md @@ -33,7 +33,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::JobResponse.new( id: null, type: null, - status: InProgress, + status: null, error_message: null, total_processed: null, total_rows: null, diff --git a/docs/A1099/V2/JobsApi.md b/docs/A1099/V2/JobsApi.md index 6d19424..c139fa2 100644 --- a/docs/A1099/V2/JobsApi.md +++ b/docs/A1099/V2/JobsApi.md @@ -36,7 +36,7 @@ api_instance = AvalaraSdk::A1099::V2::JobsApi.new api_client id = 'id_example' # String | Job id obtained from other API responses, like `/1099/bulk-upsert`. avalara_version = '2.0.0' # String | API version opts = { - x_correlation_id: 'b5e99bb8-41d6-4f87-8677-070497e8fba3', # String | Unique correlation Id in a GUID format + x_correlation_id: 'af6414fe-0bd6-4ddb-91bb-43108aa78fa5', # String | Unique correlation Id in a GUID format x_avalara_client: 'Swagger UI; 22.1.0' # String | 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/) . } diff --git a/docs/A1099/V2/TinMatchStatusResponse.md b/docs/A1099/V2/TinMatchStatusResponse.md index 81f7454..109f159 100644 --- a/docs/A1099/V2/TinMatchStatusResponse.md +++ b/docs/A1099/V2/TinMatchStatusResponse.md @@ -15,7 +15,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::TinMatchStatusResponse.new( time: null, - status: None, + status: null, irs_response: null ) ``` diff --git a/docs/A1099/V2/W4FormMinimalRequest.md b/docs/A1099/V2/W4FormMinimalRequest.md index d0b4cf9..ecceb7f 100644 --- a/docs/A1099/V2/W4FormMinimalRequest.md +++ b/docs/A1099/V2/W4FormMinimalRequest.md @@ -9,7 +9,7 @@ | **employee_first_name** | **String** | The first name of the employee. | | | **employee_last_name** | **String** | The last name of the employee. | | | **office_code** | **String** | The office code associated with the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | ## Example @@ -18,7 +18,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W4FormMinimalRequest.new( - type: W4, + type: null, email: null, employee_first_name: null, employee_last_name: null, diff --git a/docs/A1099/V2/W4FormRequest.md b/docs/A1099/V2/W4FormRequest.md index b6561ec..f1d654b 100644 --- a/docs/A1099/V2/W4FormRequest.md +++ b/docs/A1099/V2/W4FormRequest.md @@ -5,17 +5,17 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **type** | **String** | The form type (always \"w4\" for this model). | [optional][readonly] | -| **employee_first_name** | **String** | The first name of the employee. | [optional] | +| **employee_first_name** | **String** | The first name of the employee. | | | **employee_middle_name** | **String** | The middle name of the employee. | [optional] | -| **employee_last_name** | **String** | The last name of the employee. | [optional] | +| **employee_last_name** | **String** | The last name of the employee. | | | **employee_name_suffix** | **String** | The name suffix of the employee. | [optional] | -| **tin_type** | **String** | The type of TIN provided. | [optional] | -| **tin** | **String** | The taxpayer identification number (TIN). | [optional] | -| **address** | **String** | The address of the employee. | [optional] | -| **city** | **String** | The city of residence of the employee. | [optional] | -| **state** | **String** | The state of residence of the employee. | [optional] | -| **zip** | **String** | The ZIP code of residence of the employee. | [optional] | -| **marital_status** | **String** | The marital status of the employee. | [optional] | +| **tin_type** | **String** | Tax Identification Number (TIN) type. | | +| **tin** | **String** | The taxpayer identification number (TIN). | | +| **address** | **String** | The address of the employee. Required unless exempt. | [optional] | +| **city** | **String** | The city of residence of the employee. Required unless exempt. | [optional] | +| **state** | **String** | The state of residence of the employee. Required unless exempt. | [optional] | +| **zip** | **String** | The ZIP code of residence of the employee. Required unless exempt. | [optional] | +| **marital_status** | **String** | 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** | **Boolean** | Indicates whether the last name differs from prior records. | [optional] | | **num_allowances** | **Integer** | The number of allowances claimed by the employee. | [optional] | | **other_dependents** | **Integer** | The number of dependents other than allowances. | [optional] | @@ -26,7 +26,7 @@ | **office_code** | **String** | The office code associated with the form. | [optional] | | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | | **signature** | **String** | The signature of the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | | **email** | **String** | The email address of the individual associated with the form. | [optional] | @@ -36,7 +36,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W4FormRequest.new( - type: W4, + type: null, employee_first_name: null, employee_middle_name: null, employee_last_name: null, diff --git a/docs/A1099/V2/W4FormResponse.md b/docs/A1099/V2/W4FormResponse.md index d088a78..04092f9 100644 --- a/docs/A1099/V2/W4FormResponse.md +++ b/docs/A1099/V2/W4FormResponse.md @@ -4,11 +4,12 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| **type** | **String** | The form type (always \"W4\" for this model). | [optional][readonly] | | **employee_first_name** | **String** | The first name of the employee. | [optional] | | **employee_middle_name** | **String** | The middle name of the employee. | [optional] | | **employee_last_name** | **String** | The last name of the employee. | [optional] | | **employee_name_suffix** | **String** | The name suffix of the employee. | [optional] | -| **tin_type** | **String** | The type of TIN provided. | [optional] | +| **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] | | **tin** | **String** | The taxpayer identification number (TIN). | [optional] | | **address** | **String** | The address of the employee. | [optional] | | **city** | **String** | The city of residence of the employee. | [optional] | @@ -23,6 +24,19 @@ | **additional_withheld** | **Float** | The additional amount withheld. | [optional] | | **exempt_from_withholding** | **Boolean** | Indicates whether the employee is exempt from withholding. | [optional] | | **office_code** | **String** | The office code associated with the form. | [optional] | +| **id** | **String** | The unique identifier for the form. | [optional] | +| **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] | +| **reference_id** | **String** | A reference identifier for the form. | [optional] | +| **company_id** | **String** | The ID of the associated company. | [optional] | +| **display_name** | **String** | The display name associated with the form. | [optional] | +| **email** | **String** | The email address of the individual associated with the form. | [optional] | +| **archived** | **Boolean** | Indicates whether the form is archived. | [optional] | +| **ancestor_id** | **String** | Form ID of previous version. | [optional] | +| **signature** | **String** | The signature of the form. | [optional] | +| **signed_date** | **Time** | The date the form was signed. | [optional] | +| **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | +| **created_at** | **Time** | The creation date of the form. | [optional] | +| **updated_at** | **Time** | The last updated date of the form. | [optional] | ## Example @@ -30,25 +44,39 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W4FormResponse.new( - employee_first_name: Jane, - employee_middle_name: A., - employee_last_name: Smith, - employee_name_suffix: Jr., - tin_type: SSN, - tin: 123-45-6789, - address: 456 Elm St, - city: Springfield, - state: IL, - zip: 62704, - marital_status: Married, - last_name_differs: false, - num_allowances: 3, - other_dependents: 1, - non_job_income: 5000, - deductions: 2000, - additional_withheld: 150, - exempt_from_withholding: false, - office_code: OC12345 + type: null, + employee_first_name: null, + employee_middle_name: null, + employee_last_name: null, + employee_name_suffix: null, + tin_type: null, + tin: null, + address: null, + city: null, + state: null, + zip: null, + marital_status: null, + last_name_differs: null, + num_allowances: null, + other_dependents: null, + non_job_income: null, + deductions: null, + additional_withheld: null, + exempt_from_withholding: null, + office_code: null, + id: null, + entry_status: null, + reference_id: null, + company_id: null, + display_name: null, + email: null, + archived: null, + ancestor_id: null, + signature: null, + signed_date: null, + e_delivery_consented_at: null, + created_at: null, + updated_at: null ) ``` diff --git a/docs/A1099/V2/W8BenEFormMinimalRequest.md b/docs/A1099/V2/W8BenEFormMinimalRequest.md index a1940a0..d7ab8a5 100644 --- a/docs/A1099/V2/W8BenEFormMinimalRequest.md +++ b/docs/A1099/V2/W8BenEFormMinimalRequest.md @@ -8,7 +8,7 @@ | **email** | **String** | The email address of the individual associated with the form. | | | **name** | **String** | The name of the individual or entity associated with the form. | | | **reference_number** | **String** | A reference number for the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | ## Example @@ -17,7 +17,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8BenEFormMinimalRequest.new( - type: W4, + type: null, email: null, name: null, reference_number: null, diff --git a/docs/A1099/V2/W8BenEFormRequest.md b/docs/A1099/V2/W8BenEFormRequest.md index 6d15c59..9b089f1 100644 --- a/docs/A1099/V2/W8BenEFormRequest.md +++ b/docs/A1099/V2/W8BenEFormRequest.md @@ -5,17 +5,17 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **type** | **String** | The form type (always \"w8bene\" for this model). | [optional][readonly] | -| **name** | **String** | The name of the individual or entity associated with the form. | [optional] | -| **citizenship_country** | **String** | The country of citizenship. | [optional] | +| **name** | **String** | The name of the individual or entity associated with the form. | | +| **citizenship_country** | **String** | The country of citizenship. | | | **disregarded_entity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] | -| **entity_type** | **String** | The entity type. | [optional] | +| **entity_type** | **String** | 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** | **Boolean** | Indicates whether the entity is making a treaty claim. | [optional] | -| **fatca_status** | **String** | The FATCA status. | [optional] | +| **fatca_status** | **String** | 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** | **String** | The residential address of the individual or entity. | [optional] | | **residence_city** | **String** | The city of residence. | [optional] | | **residence_state** | **String** | The state of residence. | [optional] | | **residence_zip** | **String** | The ZIP code of the residence. | [optional] | -| **residence_country** | **String** | The country of residence. | [optional] | +| **residence_country** | **String** | The country of residence. | | | **residence_is_mailing** | **Boolean** | Indicates whether the residence address is also the mailing address. | [optional] | | **mailing_address** | **String** | The mailing address. | [optional] | | **mailing_city** | **String** | The city of the mailing address. | [optional] | @@ -27,7 +27,7 @@ | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] | | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] | | **reference_number** | **String** | A reference number for the form. | [optional] | -| **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. | [optional] | +| **disregarded_entity_fatca_status** | **String** | 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** | **String** | The address for disregarded entities. | [optional] | | **disregarded_city** | **String** | The city for disregarded entities. | [optional] | | **disregarded_state** | **String** | The state for disregarded entities. | [optional] | @@ -37,7 +37,7 @@ | **treaty_country_certification** | **Boolean** | Certifies the beneficial owner's country under the U.S. tax treaty. | [optional] | | **treaty_country** | **String** | The treaty country of the beneficial owner. | [optional] | | **benefit_limitation_certification** | **Boolean** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional] | -| **benefit_limitation** | **String** | The benefit limitation for tax treaty claims. | [optional] | +| **benefit_limitation** | **String** | 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** | **Boolean** | Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. | [optional] | | **treaty_article** | **String** | Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits. | [optional] | | **withholding_rate** | **String** | Specifies the reduced withholding rate claimed under the applicable tax treaty. | [optional] | @@ -61,7 +61,7 @@ | **restricted_distributor_preexisting_sales_compliance_certification** | **Boolean** | 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** | **Boolean** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] | | **iga_country** | **String** | The country for the applicable IGA with the United States. | [optional] | -| **iga_model** | **String** | The applicable IGA model. | [optional] | +| **iga_model** | **String** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] | | **iga_legal_status_treatment** | **String** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] | | **iga_ffi_trustee_or_sponsor** | **String** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] | | **iga_ffi_trustee_is_foreign** | **Boolean** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] | @@ -102,7 +102,7 @@ | **capacity_to_sign_certification** | **Boolean** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] | | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | | **signature** | **String** | The signature of the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | | **email** | **String** | The email address of the individual associated with the form. | [optional] | @@ -112,7 +112,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8BenEFormRequest.new( - type: W4, + type: null, name: null, citizenship_country: null, disregarded_entity: null, diff --git a/docs/A1099/V2/W8BenEFormResponse.md b/docs/A1099/V2/W8BenEFormResponse.md index e9c2180..0a2849a 100644 --- a/docs/A1099/V2/W8BenEFormResponse.md +++ b/docs/A1099/V2/W8BenEFormResponse.md @@ -4,6 +4,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| **type** | **String** | The form type (always \"W8BenE\" for this model). | [optional][readonly] | | **name** | **String** | The name of the individual or entity associated with the form. | [optional] | | **citizenship_country** | **String** | The country of citizenship. | [optional] | | **disregarded_entity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] | @@ -21,7 +22,7 @@ | **mailing_state** | **String** | The state of the mailing address. | [optional] | | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] | | **mailing_country** | **String** | The country of the mailing address. | [optional] | -| **tin_type** | **String** | The type of TIN provided. | [optional] | +| **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] | | **tin** | **String** | The taxpayer identification number (TIN). | [optional] | | **giin** | **String** | The global intermediary identification number (GIIN). | [optional] | | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] | @@ -100,6 +101,19 @@ | **substantial_us_owners** | [**Array<SubstantialUsOwnerResponse>**](SubstantialUsOwnerResponse.md) | The list of substantial U.S. owners of passive NFFE. | [optional] | | **signer_name** | **String** | The name of the signer. | [optional] | | **capacity_to_sign_certification** | **Boolean** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] | +| **id** | **String** | The unique identifier for the form. | [optional] | +| **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] | +| **reference_id** | **String** | A reference identifier for the form. | [optional] | +| **company_id** | **String** | The ID of the associated company. | [optional] | +| **display_name** | **String** | The display name associated with the form. | [optional] | +| **email** | **String** | The email address of the individual associated with the form. | [optional] | +| **archived** | **Boolean** | Indicates whether the form is archived. | [optional] | +| **ancestor_id** | **String** | Form ID of previous version. | [optional] | +| **signature** | **String** | The signature of the form. | [optional] | +| **signed_date** | **Time** | The date the form was signed. | [optional] | +| **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | +| **created_at** | **Time** | The creation date of the form. | [optional] | +| **updated_at** | **Time** | The last updated date of the form. | [optional] | ## Example @@ -107,29 +121,30 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8BenEFormResponse.new( - name: Global Enterprises LLC, - citizenship_country: USA, - disregarded_entity: Subsidiary LLC, - entity_type: Corporation, - making_treaty_claim: false, - fatca_status: Active, - residence_address: 123 International Blvd, - residence_city: Metropolis, - residence_state: NY, - residence_zip: 10118, - residence_country: USA, - residence_is_mailing: false, - mailing_address: P.O. Box 123, - mailing_city: Metropolis, - mailing_state: NY, - mailing_zip: 10119, - mailing_country: USA, - tin_type: , - tin: 123-45-6789, - giin: GIIN12345678, - foreign_tin_not_required: true, + type: null, + name: null, + citizenship_country: null, + disregarded_entity: null, + entity_type: null, + making_treaty_claim: null, + fatca_status: null, + residence_address: null, + residence_city: null, + residence_state: null, + residence_zip: null, + residence_country: null, + residence_is_mailing: null, + mailing_address: null, + mailing_city: null, + mailing_state: null, + mailing_zip: null, + mailing_country: null, + tin_type: null, + tin: null, + giin: null, + foreign_tin_not_required: null, foreign_tin: null, - reference_number: W8BENE12345, + reference_number: null, disregarded_entity_fatca_status: null, disregarded_address: null, disregarded_city: null, @@ -137,72 +152,85 @@ instance = AvalaraSdk::A1099::V2::W8BenEFormResponse.new( disregarded_zip: null, disregarded_country: null, disregarded_entity_giin: null, - treaty_country_certification: false, + treaty_country_certification: null, treaty_country: null, - benefit_limitation_certification: false, + benefit_limitation_certification: null, benefit_limitation: null, - qualified_resident_status_certification: false, + qualified_resident_status_certification: null, treaty_article: null, withholding_rate: null, income_type: null, treaty_reasons: null, ffi_sponsoring_entity: null, - investment_entity_certification: false, - controlled_foreign_corporation_certification: false, - compliant_nonregistering_local_bank_certification: false, - compliant_ffi_low_value_accounts_certification: false, + investment_entity_certification: null, + controlled_foreign_corporation_certification: null, + compliant_nonregistering_local_bank_certification: null, + compliant_ffi_low_value_accounts_certification: null, sponsored_closely_held_entity_sponsoring_entity: null, - sponsored_closely_held_investment_vehicle_certification: false, - compliant_limited_life_debt_entity_certification: false, - investment_entity_no_financial_accounts_certification: false, - owner_documented_ffi_certification: false, - owner_documented_ffi_reporting_statement_certification: false, - owner_documented_ffi_auditor_letter_certification: false, - owner_documented_ffi_trust_beneficiaries_certification: false, - restricted_distributor_certification: false, - restricted_distributor_agreement_certification: false, - restricted_distributor_preexisting_sales_compliance_certification: false, - nonreporting_iga_ffi_certification: false, + sponsored_closely_held_investment_vehicle_certification: null, + compliant_limited_life_debt_entity_certification: null, + investment_entity_no_financial_accounts_certification: null, + owner_documented_ffi_certification: null, + owner_documented_ffi_reporting_statement_certification: null, + owner_documented_ffi_auditor_letter_certification: null, + owner_documented_ffi_trust_beneficiaries_certification: null, + restricted_distributor_certification: null, + restricted_distributor_agreement_certification: null, + restricted_distributor_preexisting_sales_compliance_certification: null, + nonreporting_iga_ffi_certification: null, iga_country: null, iga_model: null, iga_legal_status_treatment: null, iga_ffi_trustee_or_sponsor: null, iga_ffi_trustee_is_foreign: null, - non_commercial_financial_activity_certification: false, - internation_organization_certification: false, - intergovernmental_organization_certification: false, - treaty_qualified_pension_fund_certification: false, - qualified_retirement_fund_certification: false, - narrow_participation_retirement_fund_certification: false, - section401_a_equivalent_pension_plan_certification: false, - investment_entity_for_retirement_funds_certification: false, - exempt_beneficial_owner_sponsored_retirement_fund_certification: false, - exempt_beneficial_owner_owned_investment_entity_certification: false, - territory_financial_institution_certification: false, - excepted_nonfinancial_group_entity_certification: false, - excepted_nonfinancial_start_up_certification: false, + non_commercial_financial_activity_certification: null, + internation_organization_certification: null, + intergovernmental_organization_certification: null, + treaty_qualified_pension_fund_certification: null, + qualified_retirement_fund_certification: null, + narrow_participation_retirement_fund_certification: null, + section401_a_equivalent_pension_plan_certification: null, + investment_entity_for_retirement_funds_certification: null, + exempt_beneficial_owner_sponsored_retirement_fund_certification: null, + exempt_beneficial_owner_owned_investment_entity_certification: null, + territory_financial_institution_certification: null, + excepted_nonfinancial_group_entity_certification: null, + excepted_nonfinancial_start_up_certification: null, startup_formation_or_resolution_date: null, - excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification: false, + excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification: null, nonfinancial_entity_filing_date: null, - section501_c_organization_certification: false, + section501_c_organization_certification: null, determination_letter_date: null, - nonprofit_organization_certification: false, - publicly_traded_nffe_certification: false, + nonprofit_organization_certification: null, + publicly_traded_nffe_certification: null, publicly_traded_nffe_securities_market: null, - nffe_affiliate_of_publicly_traded_entity_certification: false, + nffe_affiliate_of_publicly_traded_entity_certification: null, publicly_traded_entity: null, nffe_affiliate_of_publicly_traded_entity_securities_market: null, - excepted_territory_nffe_certification: false, - active_nffe_certification: false, - passive_nffe_certification: false, - passive_nffe_no_substantial_us_owners_certification: false, - passive_nffe_substantial_us_owners_provided_certification: false, - excepted_inter_affiliate_ffi_certification: false, - sponsored_direct_reporting_nffe_certification: false, + excepted_territory_nffe_certification: null, + active_nffe_certification: null, + passive_nffe_certification: null, + passive_nffe_no_substantial_us_owners_certification: null, + passive_nffe_substantial_us_owners_provided_certification: null, + excepted_inter_affiliate_ffi_certification: null, + sponsored_direct_reporting_nffe_certification: null, direct_reporting_nffe_sponsoring_entity: null, - substantial_us_owners: [], + substantial_us_owners: null, signer_name: null, - capacity_to_sign_certification: false + capacity_to_sign_certification: null, + id: null, + entry_status: null, + reference_id: null, + company_id: null, + display_name: null, + email: null, + archived: null, + ancestor_id: null, + signature: null, + signed_date: null, + e_delivery_consented_at: null, + created_at: null, + updated_at: null ) ``` diff --git a/docs/A1099/V2/W8BenFormMinimalRequest.md b/docs/A1099/V2/W8BenFormMinimalRequest.md index 1ef73a3..aab3ed0 100644 --- a/docs/A1099/V2/W8BenFormMinimalRequest.md +++ b/docs/A1099/V2/W8BenFormMinimalRequest.md @@ -8,7 +8,7 @@ | **email** | **String** | The email address of the individual associated with the form. | | | **name** | **String** | The name of the individual or entity associated with the form. | | | **reference_number** | **String** | A reference number for the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | ## Example @@ -17,7 +17,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8BenFormMinimalRequest.new( - type: W4, + type: null, email: null, name: null, reference_number: null, diff --git a/docs/A1099/V2/W8BenFormRequest.md b/docs/A1099/V2/W8BenFormRequest.md index ec32cf4..3510663 100644 --- a/docs/A1099/V2/W8BenFormRequest.md +++ b/docs/A1099/V2/W8BenFormRequest.md @@ -5,19 +5,19 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **type** | **String** | The form type (always \"w8ben\" for this model). | [optional][readonly] | -| **name** | **String** | The name of the individual or entity associated with the form. | [optional] | -| **citizenship_country** | **String** | The country of citizenship. | [optional] | +| **name** | **String** | The name of the individual or entity associated with the form. | | +| **citizenship_country** | **String** | The country of citizenship. | | | **residence_address** | **String** | The residential address of the individual or entity. | [optional] | | **residence_city** | **String** | The city of residence. | [optional] | | **residence_state** | **String** | The state of residence. | [optional] | | **residence_zip** | **String** | The ZIP code of the residence. | [optional] | -| **residence_country** | **String** | The country of residence. | [optional] | +| **residence_country** | **String** | The country of residence. | | | **residence_is_mailing** | **Boolean** | Indicates whether the residence address is the mailing address. | [optional] | | **mailing_address** | **String** | The mailing address. | [optional] | | **mailing_city** | **String** | The city of the mailing address. | [optional] | | **mailing_state** | **String** | The state of the mailing address. | [optional] | | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] | -| **mailing_country** | **String** | The country of the mailing address. | [optional] | +| **mailing_country** | **String** | The country of the mailing address. | | | **tin** | **String** | The taxpayer identification number (TIN). | [optional] | | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not legally required. | [optional] | | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] | @@ -31,7 +31,7 @@ | **signer_name** | **String** | The name of the signer of the form. | [optional] | | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | | **signature** | **String** | The signature of the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | | **email** | **String** | The email address of the individual associated with the form. | [optional] | @@ -41,7 +41,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8BenFormRequest.new( - type: W4, + type: null, name: null, citizenship_country: null, residence_address: null, diff --git a/docs/A1099/V2/W8BenFormResponse.md b/docs/A1099/V2/W8BenFormResponse.md index 847341b..09019b8 100644 --- a/docs/A1099/V2/W8BenFormResponse.md +++ b/docs/A1099/V2/W8BenFormResponse.md @@ -4,6 +4,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| **type** | **String** | The form type (always \"W8Ben\" for this model). | [optional][readonly] | | **name** | **String** | The name of the individual or entity associated with the form. | [optional] | | **citizenship_country** | **String** | The country of citizenship. | [optional] | | **residence_address** | **String** | The residential address of the individual or entity. | [optional] | @@ -17,7 +18,7 @@ | **mailing_state** | **String** | The state of the mailing address. | [optional] | | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] | | **mailing_country** | **String** | The country of the mailing address. | [optional] | -| **tin_type** | **String** | The type of TIN provided. | [optional] | +| **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] | | **tin** | **String** | The taxpayer identification number (TIN). | [optional] | | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] | | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] | @@ -30,6 +31,19 @@ | **income_type** | **String** | The type of income covered by the treaty. | [optional] | | **signer_name** | **String** | The name of the signer of the form. | [optional] | | **signer_capacity** | **String** | The capacity in which the signer is signing the form. | [optional] | +| **id** | **String** | The unique identifier for the form. | [optional] | +| **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] | +| **reference_id** | **String** | A reference identifier for the form. | [optional] | +| **company_id** | **String** | The ID of the associated company. | [optional] | +| **display_name** | **String** | The display name associated with the form. | [optional] | +| **email** | **String** | The email address of the individual associated with the form. | [optional] | +| **archived** | **Boolean** | Indicates whether the form is archived. | [optional] | +| **ancestor_id** | **String** | Form ID of previous version. | [optional] | +| **signature** | **String** | The signature of the form. | [optional] | +| **signed_date** | **Time** | The date the form was signed. | [optional] | +| **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | +| **created_at** | **Time** | The creation date of the form. | [optional] | +| **updated_at** | **Time** | The last updated date of the form. | [optional] | ## Example @@ -37,32 +51,46 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8BenFormResponse.new( - name: International Trading Co., - citizenship_country: US, - residence_address: 789 Global St, - residence_city: Capital City, - residence_state: DC, - residence_zip: 20001, - residence_country: US, - residence_is_mailing: false, - mailing_address: P.O. Box 456, - mailing_city: Capital City, - mailing_state: DC, - mailing_zip: 20002, - mailing_country: USA, - tin_type: SSN, - tin: 123-45-6789, - foreign_tin_not_required: false, - foreign_tin: FTIN56789, - reference_number: W8BEN12345, - birthday: Mon Oct 01 17:00:00 PDT 1990, - treaty_country: CA, - treaty_article: Article 12, - treaty_reasons: Reduced withholding, - withholding_rate: 15%, - income_type: Dividend, - signer_name: Alice Johnson, - signer_capacity: Authorized Representative + type: null, + name: null, + citizenship_country: null, + residence_address: null, + residence_city: null, + residence_state: null, + residence_zip: null, + residence_country: null, + residence_is_mailing: null, + mailing_address: null, + mailing_city: null, + mailing_state: null, + mailing_zip: null, + mailing_country: null, + tin_type: null, + tin: null, + foreign_tin_not_required: null, + foreign_tin: null, + reference_number: null, + birthday: null, + treaty_country: null, + treaty_article: null, + treaty_reasons: null, + withholding_rate: null, + income_type: null, + signer_name: null, + signer_capacity: null, + id: null, + entry_status: null, + reference_id: null, + company_id: null, + display_name: null, + email: null, + archived: null, + ancestor_id: null, + signature: null, + signed_date: null, + e_delivery_consented_at: null, + created_at: null, + updated_at: null ) ``` diff --git a/docs/A1099/V2/W8ImyFormMinimalRequest.md b/docs/A1099/V2/W8ImyFormMinimalRequest.md index a833bd3..9637a15 100644 --- a/docs/A1099/V2/W8ImyFormMinimalRequest.md +++ b/docs/A1099/V2/W8ImyFormMinimalRequest.md @@ -8,7 +8,7 @@ | **email** | **String** | The email address of the individual associated with the form. | | | **name** | **String** | The name of the individual or entity associated with the form. | | | **reference_number** | **String** | A reference number for the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | ## Example @@ -17,7 +17,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8ImyFormMinimalRequest.new( - type: W4, + type: null, email: null, name: null, reference_number: null, diff --git a/docs/A1099/V2/W8ImyFormRequest.md b/docs/A1099/V2/W8ImyFormRequest.md index ba05770..76e70db 100644 --- a/docs/A1099/V2/W8ImyFormRequest.md +++ b/docs/A1099/V2/W8ImyFormRequest.md @@ -5,28 +5,28 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **type** | **String** | The form type (always \"w8imy\" for this model). | [optional][readonly] | -| **name** | **String** | The name of the individual or entity associated with the form. | [optional] | -| **citizenship_country** | **String** | The country of citizenship. | [optional] | +| **name** | **String** | The name of the individual or entity associated with the form. | | +| **citizenship_country** | **String** | The country of citizenship. | | | **disregarded_entity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] | -| **entity_type** | **String** | The entity type. | [optional] | -| **fatca_status** | **String** | The FATCA status. | [optional] | +| **entity_type** | **String** | 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** | **String** | 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** | **String** | The residential address of the individual or entity. | [optional] | | **residence_city** | **String** | The city of residence. | [optional] | | **residence_state** | **String** | The state of residence. | [optional] | | **residence_zip** | **String** | The ZIP code of the residence. | [optional] | -| **residence_country** | **String** | The country of residence. | [optional] | +| **residence_country** | **String** | The country of residence. | | | **residence_is_mailing** | **Boolean** | Indicates whether the residence address is also the mailing address. | [optional] | | **mailing_address** | **String** | The mailing address. | [optional] | | **mailing_city** | **String** | The city of the mailing address. | [optional] | | **mailing_state** | **String** | The state of the mailing address. | [optional] | | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] | | **mailing_country** | **String** | The country of the mailing address. | [optional] | -| **tin_type** | **String** | The type of TIN provided. | [optional] | +| **tin_type** | **String** | 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** | **String** | The taxpayer identification number (TIN). | [optional] | | **giin** | **String** | The global intermediary identification number (GIIN). | [optional] | | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] | | **reference_number** | **String** | A reference number for the form. | [optional] | -| **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. | [optional] | +| **disregarded_entity_fatca_status** | **String** | 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** | **String** | The address for disregarded entities. | [optional] | | **disregarded_city** | **String** | The city for disregarded entities. | [optional] | | **disregarded_state** | **String** | The state for disregarded entities. | [optional] | @@ -90,7 +90,7 @@ | **foreign_central_bank_of_issue_certification** | **Boolean** | 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** | **Boolean** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] | | **iga_country** | **String** | The country for the applicable IGA with the United States. | [optional] | -| **iga_model** | **String** | The applicable IGA model. | [optional] | +| **iga_model** | **String** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] | | **iga_legal_status_treatment** | **String** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] | | **iga_ffi_trustee_or_sponsor** | **String** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] | | **iga_ffi_trustee_is_foreign** | **Boolean** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] | @@ -118,7 +118,7 @@ | **signer_name** | **String** | The name of the signer. | [optional] | | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | | **signature** | **String** | The signature of the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | | **email** | **String** | The email address of the individual associated with the form. | [optional] | @@ -128,7 +128,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8ImyFormRequest.new( - type: W4, + type: null, name: null, citizenship_country: null, disregarded_entity: null, diff --git a/docs/A1099/V2/W8ImyFormResponse.md b/docs/A1099/V2/W8ImyFormResponse.md index 03a524b..89fd318 100644 --- a/docs/A1099/V2/W8ImyFormResponse.md +++ b/docs/A1099/V2/W8ImyFormResponse.md @@ -4,6 +4,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| **type** | **String** | The form type (always \"W8Imy\" for this model). | [optional][readonly] | | **name** | **String** | The name of the individual or entity associated with the form. | [optional] | | **citizenship_country** | **String** | The country of citizenship. | [optional] | | **disregarded_entity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] | @@ -20,7 +21,7 @@ | **mailing_state** | **String** | The state of the mailing address. | [optional] | | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] | | **mailing_country** | **String** | The country of the mailing address. | [optional] | -| **tin_type** | **String** | The type of TIN provided. | [optional] | +| **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] | | **tin** | **String** | The taxpayer identification number (TIN). | [optional] | | **giin** | **String** | The global intermediary identification number (GIIN). | [optional] | | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] | @@ -115,6 +116,19 @@ | **sponsored_direct_reporting_nffe_certification** | **Boolean** | Certifies that the entity is a sponsored direct reporting NFFE. | [optional] | | **direct_reporting_nffe_sponsoring_entity** | **String** | The name of the entity that sponsors the direct reporting NFFE. | [optional] | | **signer_name** | **String** | The name of the signer. | [optional] | +| **id** | **String** | The unique identifier for the form. | [optional] | +| **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] | +| **reference_id** | **String** | A reference identifier for the form. | [optional] | +| **company_id** | **String** | The ID of the associated company. | [optional] | +| **display_name** | **String** | The display name associated with the form. | [optional] | +| **email** | **String** | The email address of the individual associated with the form. | [optional] | +| **archived** | **Boolean** | Indicates whether the form is archived. | [optional] | +| **ancestor_id** | **String** | Form ID of previous version. | [optional] | +| **signature** | **String** | The signature of the form. | [optional] | +| **signed_date** | **Time** | The date the form was signed. | [optional] | +| **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | +| **created_at** | **Time** | The creation date of the form. | [optional] | +| **updated_at** | **Time** | The last updated date of the form. | [optional] | ## Example @@ -122,27 +136,28 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W8ImyFormResponse.new( - name: Global Financials LLC, - citizenship_country: USA, + type: null, + name: null, + citizenship_country: null, disregarded_entity: null, - entity_type: Partnership, - fatca_status: Compliant, - residence_address: 321 Wealth Ave, - residence_city: Finance City, - residence_state: TX, - residence_zip: 75001, - residence_country: USA, - residence_is_mailing: false, - mailing_address: P.O. Box 789, - mailing_city: Finance City, - mailing_state: TX, - mailing_zip: 75002, - mailing_country: USA, - tin_type: EIN, - tin: 123-45-6789, - giin: GIIN12345678, + entity_type: null, + fatca_status: null, + residence_address: null, + residence_city: null, + residence_state: null, + residence_zip: null, + residence_country: null, + residence_is_mailing: null, + mailing_address: null, + mailing_city: null, + mailing_state: null, + mailing_zip: null, + mailing_country: null, + tin_type: null, + tin: null, + giin: null, foreign_tin: null, - reference_number: W8IMY56789, + reference_number: null, disregarded_entity_fatca_status: null, disregarded_address: null, disregarded_city: null, @@ -150,89 +165,102 @@ instance = AvalaraSdk::A1099::V2::W8ImyFormResponse.new( disregarded_zip: null, disregarded_country: null, disregarded_entity_giin: null, - qualified_intermediary_certification: false, - qi_primary_withholding_responsibility_certification: false, - qi_withholding_responsibility_for_ptp_sales_certification: false, - qi_nominee_withholding_responsibility_for_ptp_distributions_certification: false, - qi_securities_lender_substitute_dividend_withholding_certification: false, - qi_withholding_and1099_reporting_responsibility_certification: false, - qi_form1099_or_fatca_reporting_responsibility_certification: false, - qi_opt_out_of_form1099_reporting_certification: false, - qi_withholding_rate_pool_certification: false, - qi_intermediary_or_flow_through_entity_documentation_certification: false, - qualified_derivatives_dealer_certification: false, - qdd_corporation: false, - qdd_partnership: false, - qdd_disregarded_entity: false, - nonqualified_intermediary_certification: false, - nqi_withholding_statement_transmission_certification: false, - nqi_withholding_rate_pool_compliance_certification: false, - nqi_qualified_securities_lender_certification: false, - nqi_alternative_withholding_statement_verification_certification: false, - territory_financial_institution_certification: false, - tfi_treated_as_us_person_certification: false, - tfi_withholding_statement_transmission_certification: false, - tfi_treated_as_us_person_for_ptp_sales_certification: false, - tfi_nominee_us_person_for_ptp_distributions_certification: false, - tfi_not_nominee_for_ptp_distributions_certification: false, - us_branch_non_effectively_connected_income_certification: false, - us_branch_agreement_to_be_treated_as_us_person_certification: false, - us_branch_withholding_statement_and_compliance_certification: false, - us_branch_acting_as_us_person_for_ptp_sales_certification: false, - us_branch_nominee_for_ptp_distributions_certification: false, - us_branch_not_nominee_for_ptp_distributions_certification: false, - withholding_foreign_partnership_or_trust_certification: false, - nonwithholding_foreign_entity_withholding_statement_certification: false, - foreign_entity_partner_in_lower_tier_partnership_certification: false, - foreign_partnership_amount_realized_section1446_f_certification: false, - foreign_partnership_modified_amount_realized_certification: false, - foreign_grantor_trust_amount_realized_allocation_certification: false, - alternative_withholding_statement_reliance_certification: false, - np_ffi_with_exempt_beneficial_owners_certification: false, + qualified_intermediary_certification: null, + qi_primary_withholding_responsibility_certification: null, + qi_withholding_responsibility_for_ptp_sales_certification: null, + qi_nominee_withholding_responsibility_for_ptp_distributions_certification: null, + qi_securities_lender_substitute_dividend_withholding_certification: null, + qi_withholding_and1099_reporting_responsibility_certification: null, + qi_form1099_or_fatca_reporting_responsibility_certification: null, + qi_opt_out_of_form1099_reporting_certification: null, + qi_withholding_rate_pool_certification: null, + qi_intermediary_or_flow_through_entity_documentation_certification: null, + qualified_derivatives_dealer_certification: null, + qdd_corporation: null, + qdd_partnership: null, + qdd_disregarded_entity: null, + nonqualified_intermediary_certification: null, + nqi_withholding_statement_transmission_certification: null, + nqi_withholding_rate_pool_compliance_certification: null, + nqi_qualified_securities_lender_certification: null, + nqi_alternative_withholding_statement_verification_certification: null, + territory_financial_institution_certification: null, + tfi_treated_as_us_person_certification: null, + tfi_withholding_statement_transmission_certification: null, + tfi_treated_as_us_person_for_ptp_sales_certification: null, + tfi_nominee_us_person_for_ptp_distributions_certification: null, + tfi_not_nominee_for_ptp_distributions_certification: null, + us_branch_non_effectively_connected_income_certification: null, + us_branch_agreement_to_be_treated_as_us_person_certification: null, + us_branch_withholding_statement_and_compliance_certification: null, + us_branch_acting_as_us_person_for_ptp_sales_certification: null, + us_branch_nominee_for_ptp_distributions_certification: null, + us_branch_not_nominee_for_ptp_distributions_certification: null, + withholding_foreign_partnership_or_trust_certification: null, + nonwithholding_foreign_entity_withholding_statement_certification: null, + foreign_entity_partner_in_lower_tier_partnership_certification: null, + foreign_partnership_amount_realized_section1446_f_certification: null, + foreign_partnership_modified_amount_realized_certification: null, + foreign_grantor_trust_amount_realized_allocation_certification: null, + alternative_withholding_statement_reliance_certification: null, + np_ffi_with_exempt_beneficial_owners_certification: null, ffi_sponsoring_entity: null, - investment_entity_certification: false, - controlled_foreign_corporation_certification: false, - owner_documented_ffi_certification: false, - owner_documented_ffi_reporting_statement_certification: false, - owner_documented_ffi_auditor_letter_certification: false, - compliant_nonregistering_local_bank_certification: false, - compliant_ffi_low_value_accounts_certification: false, + investment_entity_certification: null, + controlled_foreign_corporation_certification: null, + owner_documented_ffi_certification: null, + owner_documented_ffi_reporting_statement_certification: null, + owner_documented_ffi_auditor_letter_certification: null, + compliant_nonregistering_local_bank_certification: null, + compliant_ffi_low_value_accounts_certification: null, sponsored_closely_held_entity_sponsoring_entity: null, - sponsored_closely_held_investment_vehicle_certification: false, - compliant_limited_life_debt_entity_certification: false, - investment_entity_no_financial_accounts_certification: false, - restricted_distributor_certification: false, - restricted_distributor_agreement_certification: false, - restricted_distributor_preexisting_sales_compliance_certification: false, - foreign_central_bank_of_issue_certification: false, - nonreporting_iga_ffi_certification: false, + sponsored_closely_held_investment_vehicle_certification: null, + compliant_limited_life_debt_entity_certification: null, + investment_entity_no_financial_accounts_certification: null, + restricted_distributor_certification: null, + restricted_distributor_agreement_certification: null, + restricted_distributor_preexisting_sales_compliance_certification: null, + foreign_central_bank_of_issue_certification: null, + nonreporting_iga_ffi_certification: null, iga_country: null, iga_model: null, iga_legal_status_treatment: null, iga_ffi_trustee_or_sponsor: null, iga_ffi_trustee_is_foreign: null, - treaty_qualified_pension_fund_certification: false, - qualified_retirement_fund_certification: false, - narrow_participation_retirement_fund_certification: false, - section401_a_equivalent_pension_plan_certification: false, - investment_entity_for_retirement_funds_certification: false, - exempt_beneficial_owner_sponsored_retirement_fund_certification: false, - excepted_nonfinancial_group_entity_certification: false, - excepted_nonfinancial_start_up_certification: false, + treaty_qualified_pension_fund_certification: null, + qualified_retirement_fund_certification: null, + narrow_participation_retirement_fund_certification: null, + section401_a_equivalent_pension_plan_certification: null, + investment_entity_for_retirement_funds_certification: null, + exempt_beneficial_owner_sponsored_retirement_fund_certification: null, + excepted_nonfinancial_group_entity_certification: null, + excepted_nonfinancial_start_up_certification: null, startup_formation_or_resolution_date: null, - excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification: false, + excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification: null, nonfinancial_entity_filing_date: null, - publicly_traded_nffe_certification: false, + publicly_traded_nffe_certification: null, publicly_traded_nffe_securities_market: null, - nffe_affiliate_of_publicly_traded_entity_certification: false, + nffe_affiliate_of_publicly_traded_entity_certification: null, publicly_traded_entity: null, nffe_affiliate_of_publicly_traded_entity_securities_market: null, - excepted_territory_nffe_certification: false, - active_nffe_certification: false, - passive_nffe_certification: false, - sponsored_direct_reporting_nffe_certification: false, + excepted_territory_nffe_certification: null, + active_nffe_certification: null, + passive_nffe_certification: null, + sponsored_direct_reporting_nffe_certification: null, direct_reporting_nffe_sponsoring_entity: null, - signer_name: null + signer_name: null, + id: null, + entry_status: null, + reference_id: null, + company_id: null, + display_name: null, + email: null, + archived: null, + ancestor_id: null, + signature: null, + signed_date: null, + e_delivery_consented_at: null, + created_at: null, + updated_at: null ) ``` diff --git a/docs/A1099/V2/W9FormBaseMinimalRequest.md b/docs/A1099/V2/W9FormBaseMinimalRequest.md index d15ce62..8150094 100644 --- a/docs/A1099/V2/W9FormBaseMinimalRequest.md +++ b/docs/A1099/V2/W9FormBaseMinimalRequest.md @@ -5,7 +5,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **type** | **String** | The form type. | [optional][readonly] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | | **email** | **String** | The email address of the individual associated with the form. | [optional] | @@ -15,7 +15,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W9FormBaseMinimalRequest.new( - type: W4, + type: null, company_id: null, reference_id: null, email: null diff --git a/docs/A1099/V2/W9FormBaseRequest.md b/docs/A1099/V2/W9FormBaseRequest.md index d6191b3..6c497bb 100644 --- a/docs/A1099/V2/W9FormBaseRequest.md +++ b/docs/A1099/V2/W9FormBaseRequest.md @@ -7,7 +7,7 @@ | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | | **signature** | **String** | The signature of the form. | [optional] | | **type** | **String** | The form type. | [optional][readonly] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | | **email** | **String** | The email address of the individual associated with the form. | [optional] | @@ -19,7 +19,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W9FormBaseRequest.new( e_delivery_consented_at: null, signature: null, - type: W4, + type: null, company_id: null, reference_id: null, email: null diff --git a/docs/A1099/V2/W9FormBaseResponse.md b/docs/A1099/V2/W9FormBaseResponse.md index 3781213..624a43a 100644 --- a/docs/A1099/V2/W9FormBaseResponse.md +++ b/docs/A1099/V2/W9FormBaseResponse.md @@ -4,6 +4,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| **type** | **String** | The form type. | [optional][readonly] | | **id** | **String** | The unique identifier for the form. | [optional] | | **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | @@ -17,7 +18,6 @@ | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | | **created_at** | **Time** | The creation date of the form. | [optional] | | **updated_at** | **Time** | The last updated date of the form. | [optional] | -| **type** | **String** | The type of the response object. | [optional] | ## Example @@ -25,6 +25,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W9FormBaseResponse.new( + type: null, id: null, entry_status: null, reference_id: null, @@ -37,8 +38,7 @@ instance = AvalaraSdk::A1099::V2::W9FormBaseResponse.new( signed_date: null, e_delivery_consented_at: null, created_at: null, - updated_at: null, - type: null + updated_at: null ) ``` diff --git a/docs/A1099/V2/W9FormMinimalRequest.md b/docs/A1099/V2/W9FormMinimalRequest.md index e79a0e5..c547091 100644 --- a/docs/A1099/V2/W9FormMinimalRequest.md +++ b/docs/A1099/V2/W9FormMinimalRequest.md @@ -8,7 +8,7 @@ | **email** | **String** | The email address of the individual associated with the form. | | | **name** | **String** | The name of the individual or entity associated with the form. | | | **account_number** | **String** | The account number associated with the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | ## Example @@ -17,7 +17,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W9FormMinimalRequest.new( - type: W4, + type: null, email: null, name: null, account_number: null, diff --git a/docs/A1099/V2/W9FormRequest.md b/docs/A1099/V2/W9FormRequest.md index 833ecb1..8824bd8 100644 --- a/docs/A1099/V2/W9FormRequest.md +++ b/docs/A1099/V2/W9FormRequest.md @@ -5,27 +5,27 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **type** | **String** | The form type (always \"w9\" for this model). | [optional][readonly] | -| **name** | **String** | The name of the individual or entity associated with the form. | [optional] | +| **name** | **String** | The name of the individual or entity associated with the form. | | | **business_name** | **String** | The name of the business associated with the form. | [optional] | -| **business_classification** | **String** | The classification of the business. | [optional] | +| **business_classification** | **String** | 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** | **String** | The classification description when \"businessClassification\" is \"Other\". | [optional] | | **foreign_partner_owner_or_beneficiary** | **Boolean** | Indicates whether the individual is a foreign partner, owner, or beneficiary. | [optional] | | **exempt_payee_code** | **String** | The exempt payee code. | [optional] | | **exempt_fatca_code** | **String** | The exemption from FATCA reporting code. | [optional] | | **foreign_country_indicator** | **Boolean** | Indicates whether the individual or entity is in a foreign country. | [optional] | -| **address** | **String** | The address of the individual or entity. | [optional] | +| **address** | **String** | The address of the individual or entity. | | | **foreign_address** | **String** | The foreign address of the individual or entity. | [optional] | -| **city** | **String** | The city of the address. | [optional] | -| **state** | **String** | The state of the address. | [optional] | -| **zip** | **String** | The ZIP code of the address. | [optional] | +| **city** | **String** | The city of the address. | | +| **state** | **String** | The state of the address. | | +| **zip** | **String** | The ZIP code of the address. | | | **account_number** | **String** | The account number associated with the form. | [optional] | -| **tin_type** | **String** | The type of TIN provided. | [optional] | -| **tin** | **String** | The taxpayer identification number (TIN). | [optional] | +| **tin_type** | **String** | Tax Identification Number (TIN) type. SSN/ITIN (for individuals) and EIN (for businesses). | | +| **tin** | **String** | The taxpayer identification number (TIN). | | | **backup_withholding** | **Boolean** | Indicates whether backup withholding applies. | [optional] | | **is1099able** | **Boolean** | Indicates whether the individual or entity should be issued a 1099 form. | [optional] | | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | | **signature** | **String** | The signature of the form. | [optional] | -| **company_id** | **String** | The ID of the associated company. | | +| **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] | | **reference_id** | **String** | A reference identifier for the form. | [optional] | | **email** | **String** | The email address of the individual associated with the form. | [optional] | @@ -35,7 +35,7 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W9FormRequest.new( - type: W4, + type: null, name: null, business_name: null, business_classification: null, diff --git a/docs/A1099/V2/W9FormResponse.md b/docs/A1099/V2/W9FormResponse.md index b0f4e21..b750341 100644 --- a/docs/A1099/V2/W9FormResponse.md +++ b/docs/A1099/V2/W9FormResponse.md @@ -4,6 +4,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| **type** | **String** | The form type (always \"W9\" for this model). | [optional][readonly] | | **name** | **String** | The name of the individual or entity associated with the form. | [optional] | | **business_name** | **String** | The name of the business associated with the form. | [optional] | | **business_classification** | **String** | The classification of the business. | [optional] | @@ -18,11 +19,24 @@ | **state** | **String** | The state of the address. | [optional] | | **zip** | **String** | The ZIP code of the address. | [optional] | | **account_number** | **String** | The account number associated with the form. | [optional] | -| **tin_type** | **String** | The type of TIN provided. | [optional] | +| **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] | | **tin** | **String** | The taxpayer identification number (TIN). | [optional] | | **backup_withholding** | **Boolean** | Indicates whether backup withholding applies. | [optional] | | **is1099able** | **Boolean** | 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** | **String** | The unique identifier for the form. | [optional] | +| **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] | +| **reference_id** | **String** | A reference identifier for the form. | [optional] | +| **company_id** | **String** | The ID of the associated company. | [optional] | +| **display_name** | **String** | The display name associated with the form. | [optional] | +| **email** | **String** | The email address of the individual associated with the form. | [optional] | +| **archived** | **Boolean** | Indicates whether the form is archived. | [optional] | +| **ancestor_id** | **String** | Form ID of previous version. | [optional] | +| **signature** | **String** | The signature of the form. | [optional] | +| **signed_date** | **Time** | The date the form was signed. | [optional] | +| **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] | +| **created_at** | **Time** | The creation date of the form. | [optional] | +| **updated_at** | **Time** | The last updated date of the form. | [optional] | ## Example @@ -30,25 +44,39 @@ require 'avalara_sdk' instance = AvalaraSdk::A1099::V2::W9FormResponse.new( - name: John Doe, - business_name: Doe Enterprises, - business_classification: LLC, + type: null, + name: null, + business_name: null, + business_classification: null, business_other: null, - foreign_partner_owner_or_beneficiary: false, + foreign_partner_owner_or_beneficiary: null, exempt_payee_code: null, exempt_fatca_code: null, - foreign_country_indicator: false, - address: 123 Main St, + foreign_country_indicator: null, + address: null, foreign_address: null, - city: Anytown, - state: CA, - zip: 90210, - account_number: ACC123456, - tin_type: EIN, - tin: 12-3456789, - backup_withholding: false, - is1099able: true, - tin_match_status: null + city: null, + state: null, + zip: null, + account_number: null, + tin_type: null, + tin: null, + backup_withholding: null, + is1099able: null, + tin_match_status: null, + id: null, + entry_status: null, + reference_id: null, + company_id: null, + display_name: null, + email: null, + archived: null, + ancestor_id: null, + signature: null, + signed_date: null, + e_delivery_consented_at: null, + created_at: null, + updated_at: null ) ``` diff --git a/lib/avalara_sdk.rb b/lib/avalara_sdk.rb index 2dd47f5..7408d5f 100644 --- a/lib/avalara_sdk.rb +++ b/lib/avalara_sdk.rb @@ -25,7 +25,9 @@ require File.expand_path( '../avalara_sdk/configuration.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/authorized_api_request_model.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/authorized_api_request_v2_data_model.rb', __FILE__) +require File.expand_path( '../avalara_sdk/models/A1099/V2/company_base.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/company_create_update_request_model.rb', __FILE__) +require File.expand_path( '../avalara_sdk/models/A1099/V2/company_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/company_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/covered_individual.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/create_and_send_w9_form_email_request.rb', __FILE__) @@ -52,7 +54,9 @@ require File.expand_path( '../avalara_sdk/models/A1099/V2/get1099_form200_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/irs_response.rb', __FILE__) +require File.expand_path( '../avalara_sdk/models/A1099/V2/issuer_base.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/issuer_command.rb', __FILE__) +require File.expand_path( '../avalara_sdk/models/A1099/V2/issuer_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/issuer_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/iw9_form_data_models_one_of.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/job_response.rb', __FILE__) @@ -71,26 +75,26 @@ require File.expand_path( '../avalara_sdk/models/A1099/V2/w4_form_data_model.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w4_form_request.rb', __FILE__) +require File.expand_path( '../avalara_sdk/models/A1099/V2/w4_form_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb', __FILE__) +require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_e_substantial_us_owner_data_model.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_form_data_model.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_form_request.rb', __FILE__) +require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_bene_form_data_model.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_imy_form_data_model.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_imy_form_request.rb', __FILE__) +require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_imy_form_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w9_form_base_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w9_form_base_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w9_form_data_model.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w9_form_request.rb', __FILE__) -require File.expand_path( '../avalara_sdk/models/A1099/V2/w4_form_response.rb', __FILE__) -require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', __FILE__) -require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', __FILE__) -require File.expand_path( '../avalara_sdk/models/A1099/V2/w8_imy_form_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/A1099/V2/w9_form_response.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/EInvoicing/V1/address.rb', __FILE__) require File.expand_path( '../avalara_sdk/models/EInvoicing/V1/bad_download_request.rb', __FILE__) diff --git a/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb b/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb index 6c6a1ca..fa1973b 100644 --- a/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +++ b/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end @@ -227,7 +227,7 @@ def build_collection_param(param, collection_format) # Create a company # Create a company. - # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param create_company_request [CreateCompanyRequest] The company to create + # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param company_request [CompanyRequest] The company to create # @return [CompanyResponse] def create_company(request_parameters) data, _status_code, _headers = create_company_with_http_info(request_parameters) @@ -240,7 +240,7 @@ def create_company(request_parameters) # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . - # @param create_company_request [CreateCompanyRequest] The company to create + # @param company_request [CompanyRequest] The company to create # @return [Array<(CompanyResponse, Integer, Hash)>] CompanyResponse data, response status code and response headers def create_company_with_http_info(request_parameters) # OAuth2 Scopes @@ -249,7 +249,7 @@ def create_company_with_http_info(request_parameters) avalara_version = request_parameters.get_avalara_version() x_correlation_id = request_parameters.get_x_correlation_id() x_avalara_client = request_parameters.get_x_avalara_client() - create_company_request = request_parameters.get_create_company_request() + company_request = request_parameters.get_company_request() # verify the required parameter 'avalara_version' is set if @api_client.config.client_side_validation && avalara_version.nil? fail ArgumentError, "Missing the required parameter 'avalara_version' when calling CompaniesW9Api.create_company" @@ -283,7 +283,7 @@ def create_company_with_http_info(request_parameters) form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(create_company_request) || {} + post_body = @api_client.object_to_http_body(company_request) || {} # return_type return_type = 'CompanyResponse' @@ -596,7 +596,7 @@ def get_company_with_http_info(request_parameters) # Update a company # Update a company. - # @param id [String] The ID of the company to update # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param create_company_request [CreateCompanyRequest] The updated company data + # @param id [String] The ID of the company to update # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param company_request [CompanyRequest] The updated company data # @return [CompanyResponse] def update_company(request_parameters) data, _status_code, _headers = update_company_with_http_info(request_parameters) @@ -610,7 +610,7 @@ def update_company(request_parameters) # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . - # @param create_company_request [CreateCompanyRequest] The updated company data + # @param company_request [CompanyRequest] The updated company data # @return [Array<(CompanyResponse, Integer, Hash)>] CompanyResponse data, response status code and response headers def update_company_with_http_info(request_parameters) # OAuth2 Scopes @@ -620,7 +620,7 @@ def update_company_with_http_info(request_parameters) avalara_version = request_parameters.get_avalara_version() x_correlation_id = request_parameters.get_x_correlation_id() x_avalara_client = request_parameters.get_x_avalara_client() - create_company_request = request_parameters.get_create_company_request() + company_request = request_parameters.get_company_request() # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesW9Api.update_company" @@ -658,7 +658,7 @@ def update_company_with_http_info(request_parameters) form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(create_company_request) || {} + post_body = @api_client.object_to_http_body(company_request) || {} # return_type return_type = 'CompanyResponse' @@ -692,7 +692,7 @@ def update_company_with_http_info(request_parameters) # @param String $avalara_version API version (required) # @param String $x_correlation_id Unique correlation Id in a GUID format (optional) # @param String $x_avalara_client 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) - # @param CreateCompanyRequest $create_company_request The company to create (optional) + # @param CompanyRequest $company_request The company to create (optional) # class CreateCompanyRequestSdk attr_accessor :avalara_version @@ -701,7 +701,7 @@ class CreateCompanyRequestSdk attr_accessor :x_avalara_client - attr_accessor :create_company_request + attr_accessor :company_request def initialize() end @@ -730,12 +730,12 @@ def set_x_avalara_client(x_avalara_client) @x_avalara_client = x_avalara_client end - def get_create_company_request() - return @create_company_request + def get_company_request() + return @company_request end - def set_create_company_request(create_company_request) - @create_company_request = create_company_request + def set_company_request(company_request) + @company_request = company_request end end # Represents the Request object for the DeleteCompany API @@ -952,7 +952,7 @@ def set_x_avalara_client(x_avalara_client) # @param String $avalara_version API version (required) # @param String $x_correlation_id Unique correlation Id in a GUID format (optional) # @param String $x_avalara_client 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) - # @param CreateCompanyRequest $create_company_request The updated company data (optional) + # @param CompanyRequest $company_request The updated company data (optional) # class UpdateCompanyRequestSdk attr_accessor :id @@ -963,7 +963,7 @@ class UpdateCompanyRequestSdk attr_accessor :x_avalara_client - attr_accessor :create_company_request + attr_accessor :company_request def initialize() end @@ -1000,12 +1000,12 @@ def set_x_avalara_client(x_avalara_client) @x_avalara_client = x_avalara_client end - def get_create_company_request() - return @create_company_request + def get_company_request() + return @company_request end - def set_create_company_request(create_company_request) - @create_company_request = create_company_request + def set_company_request(company_request) + @company_request = company_request end end end diff --git a/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb b/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb index c5d6284..318562f 100644 --- a/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +++ b/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end @@ -226,7 +226,7 @@ def build_collection_param(param, collection_format) end # 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. # @param avalara_version [String] API version # @param dry_run [Boolean] 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 # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param form1099_list_request [Form1099ListRequest] # @return [JobResponse] def bulk_upsert1099_forms(request_parameters) @@ -235,7 +235,7 @@ def bulk_upsert1099_forms(request_parameters) end # 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. # @param avalara_version [String] API version # @param dry_run [Boolean] 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 @@ -318,7 +318,7 @@ def bulk_upsert1099_forms_with_http_info(request_parameters) end # 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. # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param get1099_form200_response [Get1099Form200Response] # @return [Get1099Form200Response] def create1099_form(request_parameters) @@ -327,7 +327,7 @@ def create1099_form(request_parameters) end # 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. # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format @@ -778,7 +778,7 @@ def list1099_forms_with_http_info(request_parameters) end # 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. # @param id [String] # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param get1099_form200_response [Get1099Form200Response] # @return [Get1099Form200Response] def update1099_form(request_parameters) @@ -787,7 +787,7 @@ def update1099_form(request_parameters) end # 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. # @param id [String] # @param avalara_version [String] API version diff --git a/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb b/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb index 71ad105..2e67a95 100644 --- a/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +++ b/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end @@ -682,7 +682,7 @@ def list_w9_forms_with_http_info(request_parameters) end # 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. # @param id [String] The ID of the W9/W4/W8 form. # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @return [CreateW9Form201Response] def send_w9_form_email(request_parameters) @@ -691,7 +691,7 @@ def send_w9_form_email(request_parameters) end # 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. # @param id [String] The ID of the W9/W4/W8 form. # @param avalara_version [String] API version @@ -769,8 +769,8 @@ def send_w9_form_email_with_http_info(request_parameters) # Update a W9/W4/W8 form # Update a W9/W4/W8 form. - # @param id [String] ID of the form to update # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param iw9_form_data_models_one_of [IW9FormDataModelsOneOf] Form to be updated - # @return [IW9FormDataModelsOneOf] + # @param id [String] ID of the form to update # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param create_w9_form_request [CreateW9FormRequest] Form to be updated + # @return [CreateW9Form201Response] def update_w9_form(request_parameters) data, _status_code, _headers = update_w9_form_with_http_info(request_parameters) data @@ -783,8 +783,8 @@ def update_w9_form(request_parameters) # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . - # @param iw9_form_data_models_one_of [IW9FormDataModelsOneOf] Form to be updated - # @return [Array<(IW9FormDataModelsOneOf, Integer, Hash)>] IW9FormDataModelsOneOf data, response status code and response headers + # @param create_w9_form_request [CreateW9FormRequest] Form to be updated + # @return [Array<(CreateW9Form201Response, Integer, Hash)>] CreateW9Form201Response data, response status code and response headers def update_w9_form_with_http_info(request_parameters) # OAuth2 Scopes required_scopes = '' @@ -793,7 +793,7 @@ def update_w9_form_with_http_info(request_parameters) avalara_version = request_parameters.get_avalara_version() x_correlation_id = request_parameters.get_x_correlation_id() x_avalara_client = request_parameters.get_x_avalara_client() - iw9_form_data_models_one_of = request_parameters.get_iw9_form_data_models_one_of() + create_w9_form_request = request_parameters.get_create_w9_form_request() # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling FormsW9Api.update_w9_form" @@ -831,10 +831,10 @@ def update_w9_form_with_http_info(request_parameters) form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(iw9_form_data_models_one_of) || {} + post_body = @api_client.object_to_http_body(create_w9_form_request) || {} # return_type - return_type = 'IW9FormDataModelsOneOf' + return_type = 'CreateW9Form201Response' # auth_names auth_names = ['bearer'] @@ -1323,7 +1323,7 @@ def set_x_avalara_client(x_avalara_client) # @param String $avalara_version API version (required) # @param String $x_correlation_id Unique correlation Id in a GUID format (optional) # @param String $x_avalara_client 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) - # @param IW9FormDataModelsOneOf $iw9_form_data_models_one_of Form to be updated (optional) + # @param CreateW9FormRequest $create_w9_form_request Form to be updated (optional) # class UpdateW9FormRequestSdk attr_accessor :id @@ -1334,7 +1334,7 @@ class UpdateW9FormRequestSdk attr_accessor :x_avalara_client - attr_accessor :iw9_form_data_models_one_of + attr_accessor :create_w9_form_request def initialize() end @@ -1371,12 +1371,12 @@ def set_x_avalara_client(x_avalara_client) @x_avalara_client = x_avalara_client end - def get_iw9_form_data_models_one_of() - return @iw9_form_data_models_one_of + def get_create_w9_form_request() + return @create_w9_form_request end - def set_iw9_form_data_models_one_of(iw9_form_data_models_one_of) - @iw9_form_data_models_one_of = iw9_form_data_models_one_of + def set_create_w9_form_request(create_w9_form_request) + @create_w9_form_request = create_w9_form_request end end # Represents the Request object for the UploadW9Files API diff --git a/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb b/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb index 552babd..222e75d 100644 --- a/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +++ b/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end @@ -227,7 +227,7 @@ def build_collection_param(param, collection_format) # Create an issuer # Create an issuer (also known as a Payer). - # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param create_issuer_request [CreateIssuerRequest] The issuer to create + # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param issuer_request [IssuerRequest] The issuer to create # @return [IssuerResponse] def create_issuer(request_parameters) data, _status_code, _headers = create_issuer_with_http_info(request_parameters) @@ -240,7 +240,7 @@ def create_issuer(request_parameters) # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . - # @param create_issuer_request [CreateIssuerRequest] The issuer to create + # @param issuer_request [IssuerRequest] The issuer to create # @return [Array<(IssuerResponse, Integer, Hash)>] IssuerResponse data, response status code and response headers def create_issuer_with_http_info(request_parameters) # OAuth2 Scopes @@ -249,7 +249,7 @@ def create_issuer_with_http_info(request_parameters) avalara_version = request_parameters.get_avalara_version() x_correlation_id = request_parameters.get_x_correlation_id() x_avalara_client = request_parameters.get_x_avalara_client() - create_issuer_request = request_parameters.get_create_issuer_request() + issuer_request = request_parameters.get_issuer_request() # verify the required parameter 'avalara_version' is set if @api_client.config.client_side_validation && avalara_version.nil? fail ArgumentError, "Missing the required parameter 'avalara_version' when calling Issuers1099Api.create_issuer" @@ -283,7 +283,7 @@ def create_issuer_with_http_info(request_parameters) form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(create_issuer_request) || {} + post_body = @api_client.object_to_http_body(issuer_request) || {} # return_type return_type = 'IssuerResponse' @@ -596,7 +596,7 @@ def get_issuers_with_http_info(request_parameters) # Update an issuer # Update an issuer (also known as a Payer). - # @param id [String] Id of the issuer to update # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param create_issuer_request [CreateIssuerRequest] The issuer to update + # @param id [String] Id of the issuer to update # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . # @param issuer_request [IssuerRequest] The issuer to update # @return [nil] def update_issuer(request_parameters) update_issuer_with_http_info(request_parameters) @@ -610,7 +610,7 @@ def update_issuer(request_parameters) # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] 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/) . - # @param create_issuer_request [CreateIssuerRequest] The issuer to update + # @param issuer_request [IssuerRequest] The issuer to update # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def update_issuer_with_http_info(request_parameters) # OAuth2 Scopes @@ -620,7 +620,7 @@ def update_issuer_with_http_info(request_parameters) avalara_version = request_parameters.get_avalara_version() x_correlation_id = request_parameters.get_x_correlation_id() x_avalara_client = request_parameters.get_x_avalara_client() - create_issuer_request = request_parameters.get_create_issuer_request() + issuer_request = request_parameters.get_issuer_request() # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling Issuers1099Api.update_issuer" @@ -658,7 +658,7 @@ def update_issuer_with_http_info(request_parameters) form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(create_issuer_request) || {} + post_body = @api_client.object_to_http_body(issuer_request) || {} # return_type return_type = '' @@ -692,7 +692,7 @@ def update_issuer_with_http_info(request_parameters) # @param String $avalara_version API version (required) # @param String $x_correlation_id Unique correlation Id in a GUID format (optional) # @param String $x_avalara_client 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) - # @param CreateIssuerRequest $create_issuer_request The issuer to create (optional) + # @param IssuerRequest $issuer_request The issuer to create (optional) # class CreateIssuerRequestSdk attr_accessor :avalara_version @@ -701,7 +701,7 @@ class CreateIssuerRequestSdk attr_accessor :x_avalara_client - attr_accessor :create_issuer_request + attr_accessor :issuer_request def initialize() end @@ -730,12 +730,12 @@ def set_x_avalara_client(x_avalara_client) @x_avalara_client = x_avalara_client end - def get_create_issuer_request() - return @create_issuer_request + def get_issuer_request() + return @issuer_request end - def set_create_issuer_request(create_issuer_request) - @create_issuer_request = create_issuer_request + def set_issuer_request(issuer_request) + @issuer_request = issuer_request end end # Represents the Request object for the DeleteIssuer API @@ -952,7 +952,7 @@ def set_x_avalara_client(x_avalara_client) # @param String $avalara_version API version (required) # @param String $x_correlation_id Unique correlation Id in a GUID format (optional) # @param String $x_avalara_client 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) - # @param CreateIssuerRequest $create_issuer_request The issuer to update (optional) + # @param IssuerRequest $issuer_request The issuer to update (optional) # class UpdateIssuerRequestSdk attr_accessor :id @@ -963,7 +963,7 @@ class UpdateIssuerRequestSdk attr_accessor :x_avalara_client - attr_accessor :create_issuer_request + attr_accessor :issuer_request def initialize() end @@ -1000,12 +1000,12 @@ def set_x_avalara_client(x_avalara_client) @x_avalara_client = x_avalara_client end - def get_create_issuer_request() - return @create_issuer_request + def get_issuer_request() + return @issuer_request end - def set_create_issuer_request(create_issuer_request) - @create_issuer_request = create_issuer_request + def set_issuer_request(issuer_request) + @issuer_request = issuer_request end end end diff --git a/lib/avalara_sdk/api/A1099/V2/jobs_api.rb b/lib/avalara_sdk/api/A1099/V2/jobs_api.rb index 5551235..39c00ea 100644 --- a/lib/avalara_sdk/api/A1099/V2/jobs_api.rb +++ b/lib/avalara_sdk/api/A1099/V2/jobs_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end diff --git a/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb b/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb index fde6f1f..f8b351a 100644 --- a/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +++ b/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end diff --git a/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb b/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb index 6193695..666ebc1 100644 --- a/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +++ b/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end diff --git a/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb b/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb index 0ce26cf..9010df3 100644 --- a/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +++ b/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end diff --git a/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb b/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb index 2c09199..d73fb23 100644 --- a/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +++ b/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end diff --git a/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb b/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb index b329543..872248f 100644 --- a/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +++ b/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end diff --git a/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb b/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb index dc2f8aa..ab69731 100644 --- a/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +++ b/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end diff --git a/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb b/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb index ca6ae54..af6f132 100644 --- a/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +++ b/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb @@ -17,7 +17,7 @@ def initialize(api_client) if (api_client.nil?) fail ArgumentError,'api_client is nil' end - api_client.set_sdk_version("25.8.3") + api_client.set_sdk_version("25.9.0") @api_client = api_client end diff --git a/lib/avalara_sdk/models/A1099/V2/company_base.rb b/lib/avalara_sdk/models/A1099/V2/company_base.rb new file mode 100644 index 0000000..0aa1b3e --- /dev/null +++ b/lib/avalara_sdk/models/A1099/V2/company_base.rb @@ -0,0 +1,404 @@ +=begin +#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) + + +=end + +require 'date' +require 'time' + +module AvalaraSdk::A1099::V2 + class CompanyBase + # Legal name. Not the DBA name. + attr_accessor :name + + # Doing Business As (DBA) name or continuation of a long legal name. + attr_accessor :dba_name + + # Contact email address. For inquiries by vendors/employees. + attr_accessor :email + + # Address. + attr_accessor :address + + # City. + attr_accessor :city + + # Two-letter US state or Canadian province code (required for US/CA addresses). + attr_accessor :state + + # ZIP/postal code. + attr_accessor :zip + + # Contact phone number (must contain at least 10 digits, max 15 characters). + attr_accessor :telephone + + # Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). + attr_accessor :tin + + # Internal reference ID. Never shown to any agency or recipient. + attr_accessor :reference_id + + # Indicates whether the company authorizes IRS TIN matching. + attr_accessor :do_tin_match + + # Group name for organizing companies (creates or finds group by name). + attr_accessor :group_name + + # Province or region for non-US/CA addresses. + attr_accessor :foreign_province + + # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. + attr_accessor :country_code + + # Boolean to enable automatic reminder emails (default: false). + attr_accessor :resend_requests + + # Days between reminder emails (7-365, required if resendRequests is true). + attr_accessor :resend_interval_days + + # Maximum number of reminder attempts (1-52, required if resendRequests is true). + attr_accessor :max_reminder_attempts + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'name' => :'name', + :'dba_name' => :'dbaName', + :'email' => :'email', + :'address' => :'address', + :'city' => :'city', + :'state' => :'state', + :'zip' => :'zip', + :'telephone' => :'telephone', + :'tin' => :'tin', + :'reference_id' => :'referenceId', + :'do_tin_match' => :'doTinMatch', + :'group_name' => :'groupName', + :'foreign_province' => :'foreignProvince', + :'country_code' => :'countryCode', + :'resend_requests' => :'resendRequests', + :'resend_interval_days' => :'resendIntervalDays', + :'max_reminder_attempts' => :'maxReminderAttempts' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'name' => :'String', + :'dba_name' => :'String', + :'email' => :'String', + :'address' => :'String', + :'city' => :'String', + :'state' => :'String', + :'zip' => :'String', + :'telephone' => :'String', + :'tin' => :'String', + :'reference_id' => :'String', + :'do_tin_match' => :'Boolean', + :'group_name' => :'String', + :'foreign_province' => :'String', + :'country_code' => :'String', + :'resend_requests' => :'Boolean', + :'resend_interval_days' => :'Integer', + :'max_reminder_attempts' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'name', + :'dba_name', + :'email', + :'address', + :'city', + :'state', + :'zip', + :'telephone', + :'tin', + :'reference_id', + :'do_tin_match', + :'group_name', + :'foreign_province', + :'country_code', + :'resend_requests', + :'resend_interval_days', + :'max_reminder_attempts' + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::CompanyBase` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `AvalaraSdk::A1099::V2::CompanyBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'name') + self.name = attributes[:'name'] + else + self.name = nil + end + + if attributes.key?(:'dba_name') + self.dba_name = attributes[:'dba_name'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + else + self.email = nil + end + + if attributes.key?(:'address') + self.address = attributes[:'address'] + else + self.address = nil + end + + if attributes.key?(:'city') + self.city = attributes[:'city'] + else + self.city = nil + end + + if attributes.key?(:'state') + self.state = attributes[:'state'] + end + + if attributes.key?(:'zip') + self.zip = attributes[:'zip'] + else + self.zip = nil + end + + if attributes.key?(:'telephone') + self.telephone = attributes[:'telephone'] + else + self.telephone = nil + end + + if attributes.key?(:'tin') + self.tin = attributes[:'tin'] + else + self.tin = nil + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'do_tin_match') + self.do_tin_match = attributes[:'do_tin_match'] + end + + if attributes.key?(:'group_name') + self.group_name = attributes[:'group_name'] + end + + if attributes.key?(:'foreign_province') + self.foreign_province = attributes[:'foreign_province'] + end + + if attributes.key?(:'country_code') + self.country_code = attributes[:'country_code'] + else + self.country_code = nil + end + + if attributes.key?(:'resend_requests') + self.resend_requests = attributes[:'resend_requests'] + end + + if attributes.key?(:'resend_interval_days') + self.resend_interval_days = attributes[:'resend_interval_days'] + end + + if attributes.key?(:'max_reminder_attempts') + self.max_reminder_attempts = attributes[:'max_reminder_attempts'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + warn '[DEPRECATED] the `valid?` method is obsolete' + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + name == o.name && + dba_name == o.dba_name && + email == o.email && + address == o.address && + city == o.city && + state == o.state && + zip == o.zip && + telephone == o.telephone && + tin == o.tin && + reference_id == o.reference_id && + do_tin_match == o.do_tin_match && + group_name == o.group_name && + foreign_province == o.foreign_province && + country_code == o.country_code && + resend_requests == o.resend_requests && + resend_interval_days == o.resend_interval_days && + max_reminder_attempts == o.max_reminder_attempts + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [name, dba_name, email, address, city, state, zip, telephone, tin, reference_id, do_tin_match, group_name, foreign_province, country_code, resend_requests, resend_interval_days, max_reminder_attempts].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + transformed_hash = {} + openapi_types.each_pair do |key, type| + if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = nil + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } + end + elsif !attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) + end + end + new(transformed_hash) + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def self._deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = AvalaraSdk::A1099::V2.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/avalara_sdk/models/A1099/V2/company_request.rb b/lib/avalara_sdk/models/A1099/V2/company_request.rb new file mode 100644 index 0000000..95a385f --- /dev/null +++ b/lib/avalara_sdk/models/A1099/V2/company_request.rb @@ -0,0 +1,411 @@ +=begin +#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) + + +=end + +require 'date' +require 'time' + +module AvalaraSdk::A1099::V2 + class CompanyRequest + # Legal name. Not the DBA name. + attr_accessor :name + + # Doing Business As (DBA) name or continuation of a long legal name. + attr_accessor :dba_name + + # Contact email address. For inquiries by vendors/employees. + attr_accessor :email + + # Address. + attr_accessor :address + + # City. + attr_accessor :city + + # Two-letter US state or Canadian province code (required for US/CA addresses). + attr_accessor :state + + # ZIP/postal code. + attr_accessor :zip + + # Contact phone number (must contain at least 10 digits, max 15 characters). + attr_accessor :telephone + + # Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). + attr_accessor :tin + + # Internal reference ID. Never shown to any agency or recipient. + attr_accessor :reference_id + + # Indicates whether the company authorizes IRS TIN matching. + attr_accessor :do_tin_match + + # Group name for organizing companies (creates or finds group by name). + attr_accessor :group_name + + # Province or region for non-US/CA addresses. + attr_accessor :foreign_province + + # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. + attr_accessor :country_code + + # Boolean to enable automatic reminder emails (default: false). + attr_accessor :resend_requests + + # Days between reminder emails (7-365, required if resendRequests is true). + attr_accessor :resend_interval_days + + # Maximum number of reminder attempts (1-52, required if resendRequests is true). + attr_accessor :max_reminder_attempts + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'name' => :'name', + :'dba_name' => :'dbaName', + :'email' => :'email', + :'address' => :'address', + :'city' => :'city', + :'state' => :'state', + :'zip' => :'zip', + :'telephone' => :'telephone', + :'tin' => :'tin', + :'reference_id' => :'referenceId', + :'do_tin_match' => :'doTinMatch', + :'group_name' => :'groupName', + :'foreign_province' => :'foreignProvince', + :'country_code' => :'countryCode', + :'resend_requests' => :'resendRequests', + :'resend_interval_days' => :'resendIntervalDays', + :'max_reminder_attempts' => :'maxReminderAttempts' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'name' => :'String', + :'dba_name' => :'String', + :'email' => :'String', + :'address' => :'String', + :'city' => :'String', + :'state' => :'String', + :'zip' => :'String', + :'telephone' => :'String', + :'tin' => :'String', + :'reference_id' => :'String', + :'do_tin_match' => :'Boolean', + :'group_name' => :'String', + :'foreign_province' => :'String', + :'country_code' => :'String', + :'resend_requests' => :'Boolean', + :'resend_interval_days' => :'Integer', + :'max_reminder_attempts' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'name', + :'dba_name', + :'email', + :'address', + :'city', + :'state', + :'zip', + :'telephone', + :'tin', + :'reference_id', + :'do_tin_match', + :'group_name', + :'foreign_province', + :'country_code', + :'resend_requests', + :'resend_interval_days', + :'max_reminder_attempts' + ]) + end + + # List of class defined in allOf (OpenAPI v3) + def self.openapi_all_of + [ + :'CompanyBase' + ] + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::CompanyRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `AvalaraSdk::A1099::V2::CompanyRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'name') + self.name = attributes[:'name'] + else + self.name = nil + end + + if attributes.key?(:'dba_name') + self.dba_name = attributes[:'dba_name'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + else + self.email = nil + end + + if attributes.key?(:'address') + self.address = attributes[:'address'] + else + self.address = nil + end + + if attributes.key?(:'city') + self.city = attributes[:'city'] + else + self.city = nil + end + + if attributes.key?(:'state') + self.state = attributes[:'state'] + end + + if attributes.key?(:'zip') + self.zip = attributes[:'zip'] + else + self.zip = nil + end + + if attributes.key?(:'telephone') + self.telephone = attributes[:'telephone'] + else + self.telephone = nil + end + + if attributes.key?(:'tin') + self.tin = attributes[:'tin'] + else + self.tin = nil + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'do_tin_match') + self.do_tin_match = attributes[:'do_tin_match'] + end + + if attributes.key?(:'group_name') + self.group_name = attributes[:'group_name'] + end + + if attributes.key?(:'foreign_province') + self.foreign_province = attributes[:'foreign_province'] + end + + if attributes.key?(:'country_code') + self.country_code = attributes[:'country_code'] + else + self.country_code = nil + end + + if attributes.key?(:'resend_requests') + self.resend_requests = attributes[:'resend_requests'] + end + + if attributes.key?(:'resend_interval_days') + self.resend_interval_days = attributes[:'resend_interval_days'] + end + + if attributes.key?(:'max_reminder_attempts') + self.max_reminder_attempts = attributes[:'max_reminder_attempts'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + warn '[DEPRECATED] the `valid?` method is obsolete' + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + name == o.name && + dba_name == o.dba_name && + email == o.email && + address == o.address && + city == o.city && + state == o.state && + zip == o.zip && + telephone == o.telephone && + tin == o.tin && + reference_id == o.reference_id && + do_tin_match == o.do_tin_match && + group_name == o.group_name && + foreign_province == o.foreign_province && + country_code == o.country_code && + resend_requests == o.resend_requests && + resend_interval_days == o.resend_interval_days && + max_reminder_attempts == o.max_reminder_attempts + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [name, dba_name, email, address, city, state, zip, telephone, tin, reference_id, do_tin_match, group_name, foreign_province, country_code, resend_requests, resend_interval_days, max_reminder_attempts].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + transformed_hash = {} + openapi_types.each_pair do |key, type| + if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = nil + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } + end + elsif !attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) + end + end + new(transformed_hash) + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def self._deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = AvalaraSdk::A1099::V2.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/avalara_sdk/models/A1099/V2/company_response.rb b/lib/avalara_sdk/models/A1099/V2/company_response.rb index f927c02..27bcffa 100644 --- a/lib/avalara_sdk/models/A1099/V2/company_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/company_response.rb @@ -154,7 +154,7 @@ def self.openapi_nullable # List of class defined in allOf (OpenAPI v3) def self.openapi_all_of [ - :'CompanyCreateUpdateRequestModel' + :'CompanyBase' ] end diff --git a/lib/avalara_sdk/models/A1099/V2/error_response.rb b/lib/avalara_sdk/models/A1099/V2/error_response.rb index 829a09d..313c6df 100644 --- a/lib/avalara_sdk/models/A1099/V2/error_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/error_response.rb @@ -85,12 +85,6 @@ def valid? true end - # Custom attribute writer method with validation - # @param [Object] errors Value to be assigned - def errors=(errors) - @errors = errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1042_s.rb b/lib/avalara_sdk/models/A1099/V2/form1042_s.rb index f400d3d..3a82be4 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1042_s.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1042_s.rb @@ -12,6 +12,7 @@ module AvalaraSdk::A1099::V2 # Form 1042-S: Foreign Person's U.S. Source Income Subject to Withholding class Form1042S + # 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 attr_accessor :tin_type # Unique form identifier @@ -71,10 +72,10 @@ class Form1042S # Tax paid by withholding agent attr_accessor :tax_paid_agent - # 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 + # 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 attr_accessor :chap3_status_code - # 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 + # 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 attr_accessor :chap4_status_code # Primary withholding agent information @@ -83,7 +84,7 @@ class Form1042S # Intermediary or flow-through entity information attr_accessor :intermediary_or_flow_through - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -92,13 +93,13 @@ class Form1042S # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -143,16 +144,16 @@ class Form1042S # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -170,22 +171,22 @@ class Form1042S # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -414,6 +415,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -735,7 +737,7 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) lob_code_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12"]) return false unless lob_code_validator.valid?(@lob_code) @@ -754,7 +756,7 @@ def valid? chap4_status_code_validator = EnumAttributeValidator.new('String', ["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 false unless chap4_status_code_validator.valid?(@chap4_status_code) return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) true end @@ -762,7 +764,7 @@ def valid? # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @@ -852,25 +854,13 @@ def chap4_status_code=(chap4_status_code) # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1095_b.rb b/lib/avalara_sdk/models/A1099/V2/form1095_b.rb index 12d9490..ce70fdc 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1095_b.rb @@ -27,13 +27,13 @@ class Form1095B # Employee's date of birth attr_accessor :employee_date_of_birth - # 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. 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) attr_accessor :origin_of_health_coverage_code # Covered individuals information - At least one month of coverage must be entered if it's not a correction. attr_accessor :covered_individuals - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -42,13 +42,13 @@ class Form1095B # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -60,7 +60,7 @@ class Form1095B # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -96,16 +96,16 @@ class Form1095B # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -123,22 +123,22 @@ class Form1095B # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -318,6 +318,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -576,9 +577,9 @@ def valid? origin_of_health_coverage_code_validator = EnumAttributeValidator.new('String', ["A", "B", "C", "D", "E", "F", "G"]) return false unless origin_of_health_coverage_code_validator.valid?(@origin_of_health_coverage_code) return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end @@ -593,20 +594,10 @@ def origin_of_health_coverage_code=(origin_of_health_coverage_code) @origin_of_health_coverage_code = origin_of_health_coverage_code end - # Custom attribute writer method with validation - # @param [Object] covered_individuals Value to be assigned - def covered_individuals=(covered_individuals) - if covered_individuals.nil? - fail ArgumentError, 'covered_individuals cannot be nil' - end - - @covered_individuals = covered_individuals - end - # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -616,25 +607,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1095_c.rb b/lib/avalara_sdk/models/A1099/V2/form1095_c.rb index 26a4ec5..c0ace38 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1095_c.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1095_c.rb @@ -39,7 +39,7 @@ class Form1095C # Covered individuals information attr_accessor :covered_individuals - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -48,13 +48,13 @@ class Form1095C # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -66,7 +66,7 @@ class Form1095C # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -102,16 +102,16 @@ class Form1095C # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -129,22 +129,22 @@ class Form1095C # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -329,6 +329,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -604,9 +605,9 @@ def valid? return false unless plan_start_month_validator.valid?(@plan_start_month) return false if @offer_and_coverages.nil? return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end @@ -621,30 +622,10 @@ def plan_start_month=(plan_start_month) @plan_start_month = plan_start_month end - # Custom attribute writer method with validation - # @param [Object] offer_and_coverages Value to be assigned - def offer_and_coverages=(offer_and_coverages) - if offer_and_coverages.nil? - fail ArgumentError, 'offer_and_coverages cannot be nil' - end - - @offer_and_coverages = offer_and_coverages - end - - # Custom attribute writer method with validation - # @param [Object] covered_individuals Value to be assigned - def covered_individuals=(covered_individuals) - if covered_individuals.nil? - fail ArgumentError, 'covered_individuals cannot be nil' - end - - @covered_individuals = covered_individuals - end - # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -654,25 +635,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1099_base.rb b/lib/avalara_sdk/models/A1099/V2/form1099_base.rb index 673ce31..2b29ac4 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1099_base.rb @@ -11,7 +11,7 @@ module AvalaraSdk::A1099::V2 class Form1099Base - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -20,13 +20,13 @@ class Form1099Base # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -38,7 +38,7 @@ class Form1099Base # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -74,16 +74,16 @@ class Form1099Base # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -101,22 +101,22 @@ class Form1099Base # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -276,6 +276,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -489,9 +490,9 @@ def list_invalid_properties def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end @@ -499,7 +500,7 @@ def valid? # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -509,25 +510,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1099_div.rb b/lib/avalara_sdk/models/A1099/V2/form1099_div.rb index b81a704..ba85f7f 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1099_div.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1099_div.rb @@ -10,7 +10,7 @@ require 'time' module AvalaraSdk::A1099::V2 - # 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. class Form1099Div # Total ordinary dividends attr_accessor :total_ordinary_dividends @@ -66,10 +66,10 @@ class Form1099Div # Specified private activity bond interest dividends attr_accessor :specified_private_activity_bond_interest_dividends - # FATCA filing requirement + # FATCA filing requirement. attr_accessor :fatca_filing_requirement - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -78,13 +78,13 @@ class Form1099Div # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -96,7 +96,7 @@ class Form1099Div # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -132,16 +132,16 @@ class Form1099Div # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -159,22 +159,22 @@ class Form1099Div # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -391,6 +391,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -687,9 +688,9 @@ def list_invalid_properties def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end @@ -697,7 +698,7 @@ def valid? # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -707,25 +708,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1099_int.rb b/lib/avalara_sdk/models/A1099/V2/form1099_int.rb index 3517788..8f6dfca 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1099_int.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1099_int.rb @@ -10,7 +10,8 @@ require 'time' module AvalaraSdk::A1099::V2 - class 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. + class Form1099Int # Interest Income attr_accessor :interest_income @@ -50,13 +51,13 @@ class Form1099Int # Bond Premium on tax exempt bond attr_accessor :bond_premium_on_tax_exempt_bond - # Tax exempt bond CUSIP no. + # Tax exempt bond CUSIP no. Enter VARIOUS if the tax-exempt interest is reported in the aggregate for multiple bonds or accounts. attr_accessor :tax_exempt_bond_cusip_number - # FATCA filing requirement + # FATCA filing requirement. attr_accessor :fatca_filing_requirement - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -65,13 +66,13 @@ class Form1099Int # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -83,7 +84,7 @@ class Form1099Int # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -119,16 +120,16 @@ class Form1099Int # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -146,22 +147,22 @@ class Form1099Int # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -366,6 +367,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -646,9 +648,9 @@ def list_invalid_properties def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end @@ -656,7 +658,7 @@ def valid? # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -666,25 +668,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1099_k.rb b/lib/avalara_sdk/models/A1099/V2/form1099_k.rb index dc86519..05f92c9 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1099_k.rb @@ -12,22 +12,22 @@ module AvalaraSdk::A1099::V2 # Form 1099-K: Payment Card and Third Party Network Transactions class Form1099K - # Filer type (PSE or EPF) + # Filer type for tax reporting purposes. Available values: - PSE: Payment Settlement Entity - EPF: Electronic Payment Facilitator or other third party attr_accessor :filer_type - # Payment type (payment card or third party network) + # Payment type for transaction classification. Available values: - PaymentCard: Payment card transactions - ThirdPartyNetwork: Third party network transactions attr_accessor :payment_type - # Payment settlement entity name and phone number + # Payment settlement entity name and phone number, if different from Filer's attr_accessor :payment_settlement_entity_name_phone_number - # Gross amount of payment card/third party network transactions + # Gross amount of payment card/third party network transactions. This value must equal the total of all monthly payment amounts (January through December). attr_accessor :gross_amount_payment_card # Card not present transactions attr_accessor :card_not_present_transactions - # Merchant category code + # Merchant category code (4 numbers) attr_accessor :merchant_category_code # Number of payment transactions @@ -72,7 +72,7 @@ class Form1099K # December gross payments attr_accessor :december - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -81,13 +81,13 @@ class Form1099K # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -99,7 +99,7 @@ class Form1099K # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -135,16 +135,16 @@ class Form1099K # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -162,22 +162,22 @@ class Form1099K # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -397,6 +397,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -431,10 +432,14 @@ def initialize(attributes = {}) if attributes.key?(:'filer_type') self.filer_type = attributes[:'filer_type'] + else + self.filer_type = nil end if attributes.key?(:'payment_type') self.payment_type = attributes[:'payment_type'] + else + self.payment_type = nil end if attributes.key?(:'payment_settlement_entity_name_phone_number') @@ -443,6 +448,8 @@ def initialize(attributes = {}) if attributes.key?(:'gross_amount_payment_card') self.gross_amount_payment_card = attributes[:'gross_amount_payment_card'] + else + self.gross_amount_payment_card = nil end if attributes.key?(:'card_not_present_transactions') @@ -455,6 +462,8 @@ def initialize(attributes = {}) if attributes.key?(:'payment_transaction_number') self.payment_transaction_number = attributes[:'payment_transaction_number'] + else + self.payment_transaction_number = nil end if attributes.key?(:'federal_income_tax_withheld') @@ -696,14 +705,14 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - filer_type_validator = EnumAttributeValidator.new('String', ["PSE", "EPF", "Other"]) + filer_type_validator = EnumAttributeValidator.new('String', ["PSE", "EPF"]) return false unless filer_type_validator.valid?(@filer_type) - payment_type_validator = EnumAttributeValidator.new('String', ["MerchantPaymentCard", "ThirdPartyNetwork"]) + payment_type_validator = EnumAttributeValidator.new('String', ["PaymentCard", "ThirdPartyNetwork"]) return false unless payment_type_validator.valid?(@payment_type) return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end @@ -711,7 +720,7 @@ def valid? # Custom attribute writer method checking allowed values (enum). # @param [Object] filer_type Object to be assigned def filer_type=(filer_type) - validator = EnumAttributeValidator.new('String', ["PSE", "EPF", "Other"]) + validator = EnumAttributeValidator.new('String', ["PSE", "EPF"]) unless validator.valid?(filer_type) fail ArgumentError, "invalid value for \"filer_type\", must be one of #{validator.allowable_values}." end @@ -721,7 +730,7 @@ def filer_type=(filer_type) # Custom attribute writer method checking allowed values (enum). # @param [Object] payment_type Object to be assigned def payment_type=(payment_type) - validator = EnumAttributeValidator.new('String', ["MerchantPaymentCard", "ThirdPartyNetwork"]) + validator = EnumAttributeValidator.new('String', ["PaymentCard", "ThirdPartyNetwork"]) unless validator.valid?(payment_type) fail ArgumentError, "invalid value for \"payment_type\", must be one of #{validator.allowable_values}." end @@ -731,7 +740,7 @@ def payment_type=(payment_type) # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -741,25 +750,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1099_list_request.rb b/lib/avalara_sdk/models/A1099/V2/form1099_list_request.rb index c74645a..d6ebbc9 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1099_list_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1099_list_request.rb @@ -102,7 +102,7 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) true end @@ -110,23 +110,13 @@ def valid? # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end - # Custom attribute writer method with validation - # @param [Object] forms Value to be assigned - def forms=(forms) - if forms.nil? - fail ArgumentError, 'forms cannot be nil' - end - - @forms = forms - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb b/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb index cb43193..7f9df6f 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb @@ -10,7 +10,7 @@ require 'time' module AvalaraSdk::A1099::V2 - # 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 class Form1099Misc # Rents attr_accessor :rents @@ -54,10 +54,10 @@ class Form1099Misc # Nonqualified deferred compensation attr_accessor :nonqualified_deferred_compensation - # FATCA filing requirement + # FATCA filing requirement. attr_accessor :fatca_filing_requirement - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -66,13 +66,13 @@ class Form1099Misc # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -84,7 +84,7 @@ class Form1099Misc # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -120,16 +120,16 @@ class Form1099Misc # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -147,22 +147,22 @@ class Form1099Misc # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -367,6 +367,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -647,9 +648,9 @@ def list_invalid_properties def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end @@ -657,7 +658,7 @@ def valid? # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -667,25 +668,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb b/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb index 5c08a78..5888d5d 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb @@ -10,17 +10,18 @@ require 'time' module AvalaraSdk::A1099::V2 - class Form1099Nec - # Nonemployee compensation + # Form 1099-NEC: Nonemployee Compensation + class Form1099Nec + # Nonemployee compensation. Required if DirectSalesIndicator is false. attr_accessor :nonemployee_compensation - # Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale + # 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. attr_accessor :direct_sales_indicator - # Federal income tax withheld + # Federal income tax withheld. attr_accessor :federal_income_tax_withheld - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -29,13 +30,13 @@ class Form1099Nec # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -47,7 +48,7 @@ class Form1099Nec # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -83,16 +84,16 @@ class Form1099Nec # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -110,22 +111,22 @@ class Form1099Nec # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -294,6 +295,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -528,9 +530,9 @@ def list_invalid_properties def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end @@ -538,7 +540,7 @@ def valid? # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -548,25 +550,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/form1099_r.rb b/lib/avalara_sdk/models/A1099/V2/form1099_r.rb index 471c2a7..e984e43 100644 --- a/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +++ b/lib/avalara_sdk/models/A1099/V2/form1099_r.rb @@ -10,7 +10,7 @@ require 'time' module AvalaraSdk::A1099::V2 - # 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 class Form1099R # Gross distribution attr_accessor :gross_distribution @@ -36,10 +36,10 @@ class Form1099R # Net unrealized appreciation in employer's securities attr_accessor :net_unrealized_appreciation_in_employer_securities - # Distribution code + # 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 attr_accessor :distribution_code - # Second distribution code + # 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) attr_accessor :second_distribution_code # IRA/SEP/SIMPLE @@ -69,10 +69,10 @@ class Form1099R # Date of payment attr_accessor :date_of_payment - # FATCA filing requirement + # FATCA filing requirement. attr_accessor :fatca_filing_requirement - # Form type + # Form type. attr_accessor :type # Form ID. Unique identifier set when the record is created. @@ -81,13 +81,13 @@ class Form1099R # Issuer ID - only required when creating forms attr_accessor :issuer_id - # Issuer Reference ID - only required when creating forms + # Issuer Reference ID - only required when creating forms via $bulk-upsert attr_accessor :issuer_reference_id # Issuer TIN - readonly attr_accessor :issuer_tin - # Tax Year - only required when creating forms + # Tax Year - only required when creating forms via $bulk-upsert attr_accessor :tax_year # Internal reference ID. Never shown to any agency or recipient. @@ -99,7 +99,7 @@ class Form1099R # Recipient name attr_accessor :recipient_name - # Type of TIN (Tax ID Number) + # 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 attr_accessor :tin_type # Recipient second name @@ -135,16 +135,16 @@ class Form1099R # Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. attr_accessor :country_code - # Date when federal e-filing should be scheduled for this form + # 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. attr_accessor :federal_efile_date # Boolean indicating that postal mailing to the recipient should be scheduled for this form attr_accessor :postal_mail - # Date when state e-filing should be scheduled for this form + # 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. attr_accessor :state_efile_date - # Date when recipient e-delivery should be scheduled for this form + # 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. attr_accessor :recipient_edelivery_date # Boolean indicating that TIN Matching should be scheduled for this form @@ -162,22 +162,22 @@ class Form1099R # Second TIN notice attr_accessor :second_tin_notice - # Federal e-file status + # 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) attr_accessor :federal_efile_status - # State e-file status + # 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 attr_accessor :state_efile_status - # Postal mail to recipient status + # 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 attr_accessor :postal_mail_status - # TIN Match status + # 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 attr_accessor :tin_match_status - # Address verification status + # 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 attr_accessor :address_verification_status - # EDelivery status + # 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) attr_accessor :e_delivery_status # Validation errors @@ -397,6 +397,7 @@ def self.openapi_nullable :'no_tin', :'address_verification', :'state_and_local_withholding', + :'second_tin_notice', :'federal_efile_status', :'state_efile_status', :'postal_mail_status', @@ -463,6 +464,8 @@ def initialize(attributes = {}) if attributes.key?(:'distribution_code') self.distribution_code = attributes[:'distribution_code'] + else + self.distribution_code = nil end if attributes.key?(:'second_distribution_code') @@ -696,18 +699,42 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' + distribution_code_validator = EnumAttributeValidator.new('String', ["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 false unless distribution_code_validator.valid?(@distribution_code) + second_distribution_code_validator = EnumAttributeValidator.new('String', ["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 false unless second_distribution_code_validator.valid?(@second_distribution_code) return false if @type.nil? - type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + type_validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) return false unless type_validator.valid?(@type) - tin_type_validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) return false unless tin_type_validator.valid?(@tin_type) true end + # Custom attribute writer method checking allowed values (enum). + # @param [Object] distribution_code Object to be assigned + def distribution_code=(distribution_code) + validator = EnumAttributeValidator.new('String', ["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"]) + unless validator.valid?(distribution_code) + fail ArgumentError, "invalid value for \"distribution_code\", must be one of #{validator.allowable_values}." + end + @distribution_code = distribution_code + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] second_distribution_code Object to be assigned + def second_distribution_code=(second_distribution_code) + validator = EnumAttributeValidator.new('String', ["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"]) + unless validator.valid?(second_distribution_code) + fail ArgumentError, "invalid value for \"second_distribution_code\", must be one of #{validator.allowable_values}." + end + @second_distribution_code = second_distribution_code + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) - validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C", "1099-INT"]) + validator = EnumAttributeValidator.new('String', ["Form1099Nec", "Form1099Misc", "Form1099Div", "Form1099R", "Form1099K", "Form1095B", "Form1042S", "Form1095C", "Form1099Int"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @@ -717,25 +744,13 @@ def type=(type) # Custom attribute writer method checking allowed values (enum). # @param [Object] tin_type Object to be assigned def tin_type=(tin_type) - validator = EnumAttributeValidator.new('String', ["Empty", "EIN", "SSN", "ITIN", "ATIN"]) + validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"]) unless validator.valid?(tin_type) fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}." end @tin_type = tin_type end - # Custom attribute writer method with validation - # @param [Object] state_efile_status Value to be assigned - def state_efile_status=(state_efile_status) - @state_efile_status = state_efile_status - end - - # Custom attribute writer method with validation - # @param [Object] validation_errors Value to be assigned - def validation_errors=(validation_errors) - @validation_errors = validation_errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb b/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb index a6e12ce..a4997a6 100644 --- a/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb +++ b/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb @@ -15,10 +15,10 @@ class IntermediaryOrFlowThrough # EIN (Employer Identification Number) of the intermediary or flow-through entity attr_accessor :ein - # Chapter 3 status code for the intermediary or flow-through entity + # 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 attr_accessor :chap3_status_code - # Chapter 4 status code for the intermediary or flow-through entity + # 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 attr_accessor :chap4_status_code # Name of the intermediary or flow-through entity @@ -45,6 +45,28 @@ class IntermediaryOrFlowThrough # Zip code of the intermediary or flow-through entity attr_accessor :zip + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -173,9 +195,33 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' + chap3_status_code_validator = EnumAttributeValidator.new('String', ["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 false unless chap3_status_code_validator.valid?(@chap3_status_code) + chap4_status_code_validator = EnumAttributeValidator.new('String', ["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 false unless chap4_status_code_validator.valid?(@chap4_status_code) true end + # Custom attribute writer method checking allowed values (enum). + # @param [Object] chap3_status_code Object to be assigned + def chap3_status_code=(chap3_status_code) + validator = EnumAttributeValidator.new('String', ["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"]) + unless validator.valid?(chap3_status_code) + fail ArgumentError, "invalid value for \"chap3_status_code\", must be one of #{validator.allowable_values}." + end + @chap3_status_code = chap3_status_code + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] chap4_status_code Object to be assigned + def chap4_status_code=(chap4_status_code) + validator = EnumAttributeValidator.new('String', ["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"]) + unless validator.valid?(chap4_status_code) + fail ArgumentError, "invalid value for \"chap4_status_code\", must be one of #{validator.allowable_values}." + end + @chap4_status_code = chap4_status_code + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/issuer_base.rb b/lib/avalara_sdk/models/A1099/V2/issuer_base.rb new file mode 100644 index 0000000..f5ca843 --- /dev/null +++ b/lib/avalara_sdk/models/A1099/V2/issuer_base.rb @@ -0,0 +1,384 @@ +=begin +#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) + + +=end + +require 'date' +require 'time' + +module AvalaraSdk::A1099::V2 + class IssuerBase + # Legal name. Not the DBA name. + attr_accessor :name + + # Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. + attr_accessor :dba_name + + # Federal Tax Identification Number (TIN). + attr_accessor :tin + + # 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. + attr_accessor :reference_id + + # Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. + attr_accessor :telephone + + # Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. + attr_accessor :tax_year + + # 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. + attr_accessor :country_code + + # Contact email address. For recipient inquiries. + attr_accessor :email + + # Address. + attr_accessor :address + + # City. + attr_accessor :city + + # Two-letter US state or Canadian province code (required for US/CA addresses). + attr_accessor :state + + # ZIP/postal code. + attr_accessor :zip + + # Province or region for non-US/CA addresses. + attr_accessor :foreign_province + + # Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. + attr_accessor :transfer_agent_name + + # Indicates if this is the issuer's final year filing. + attr_accessor :last_filing + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'name' => :'name', + :'dba_name' => :'dbaName', + :'tin' => :'tin', + :'reference_id' => :'referenceId', + :'telephone' => :'telephone', + :'tax_year' => :'taxYear', + :'country_code' => :'countryCode', + :'email' => :'email', + :'address' => :'address', + :'city' => :'city', + :'state' => :'state', + :'zip' => :'zip', + :'foreign_province' => :'foreignProvince', + :'transfer_agent_name' => :'transferAgentName', + :'last_filing' => :'lastFiling' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'name' => :'String', + :'dba_name' => :'String', + :'tin' => :'String', + :'reference_id' => :'String', + :'telephone' => :'String', + :'tax_year' => :'Integer', + :'country_code' => :'String', + :'email' => :'String', + :'address' => :'String', + :'city' => :'String', + :'state' => :'String', + :'zip' => :'String', + :'foreign_province' => :'String', + :'transfer_agent_name' => :'String', + :'last_filing' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'name', + :'dba_name', + :'tin', + :'reference_id', + :'telephone', + :'tax_year', + :'country_code', + :'email', + :'address', + :'city', + :'state', + :'zip', + :'foreign_province', + :'transfer_agent_name', + :'last_filing' + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::IssuerBase` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `AvalaraSdk::A1099::V2::IssuerBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'name') + self.name = attributes[:'name'] + else + self.name = nil + end + + if attributes.key?(:'dba_name') + self.dba_name = attributes[:'dba_name'] + end + + if attributes.key?(:'tin') + self.tin = attributes[:'tin'] + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'telephone') + self.telephone = attributes[:'telephone'] + else + self.telephone = nil + end + + if attributes.key?(:'tax_year') + self.tax_year = attributes[:'tax_year'] + else + self.tax_year = nil + end + + if attributes.key?(:'country_code') + self.country_code = attributes[:'country_code'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + else + self.email = nil + end + + if attributes.key?(:'address') + self.address = attributes[:'address'] + else + self.address = nil + end + + if attributes.key?(:'city') + self.city = attributes[:'city'] + else + self.city = nil + end + + if attributes.key?(:'state') + self.state = attributes[:'state'] + else + self.state = nil + end + + if attributes.key?(:'zip') + self.zip = attributes[:'zip'] + else + self.zip = nil + end + + if attributes.key?(:'foreign_province') + self.foreign_province = attributes[:'foreign_province'] + end + + if attributes.key?(:'transfer_agent_name') + self.transfer_agent_name = attributes[:'transfer_agent_name'] + end + + if attributes.key?(:'last_filing') + self.last_filing = attributes[:'last_filing'] + else + self.last_filing = nil + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + warn '[DEPRECATED] the `valid?` method is obsolete' + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + name == o.name && + dba_name == o.dba_name && + tin == o.tin && + reference_id == o.reference_id && + telephone == o.telephone && + tax_year == o.tax_year && + country_code == o.country_code && + email == o.email && + address == o.address && + city == o.city && + state == o.state && + zip == o.zip && + foreign_province == o.foreign_province && + transfer_agent_name == o.transfer_agent_name && + last_filing == o.last_filing + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [name, dba_name, tin, reference_id, telephone, tax_year, country_code, email, address, city, state, zip, foreign_province, transfer_agent_name, last_filing].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + transformed_hash = {} + openapi_types.each_pair do |key, type| + if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = nil + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } + end + elsif !attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) + end + end + new(transformed_hash) + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def self._deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = AvalaraSdk::A1099::V2.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/avalara_sdk/models/A1099/V2/issuer_request.rb b/lib/avalara_sdk/models/A1099/V2/issuer_request.rb new file mode 100644 index 0000000..8e9380b --- /dev/null +++ b/lib/avalara_sdk/models/A1099/V2/issuer_request.rb @@ -0,0 +1,391 @@ +=begin +#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) + + +=end + +require 'date' +require 'time' + +module AvalaraSdk::A1099::V2 + class IssuerRequest + # Legal name. Not the DBA name. + attr_accessor :name + + # Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. + attr_accessor :dba_name + + # Federal Tax Identification Number (TIN). + attr_accessor :tin + + # 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. + attr_accessor :reference_id + + # Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. + attr_accessor :telephone + + # Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. + attr_accessor :tax_year + + # 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. + attr_accessor :country_code + + # Contact email address. For recipient inquiries. + attr_accessor :email + + # Address. + attr_accessor :address + + # City. + attr_accessor :city + + # Two-letter US state or Canadian province code (required for US/CA addresses). + attr_accessor :state + + # ZIP/postal code. + attr_accessor :zip + + # Province or region for non-US/CA addresses. + attr_accessor :foreign_province + + # Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. + attr_accessor :transfer_agent_name + + # Indicates if this is the issuer's final year filing. + attr_accessor :last_filing + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'name' => :'name', + :'dba_name' => :'dbaName', + :'tin' => :'tin', + :'reference_id' => :'referenceId', + :'telephone' => :'telephone', + :'tax_year' => :'taxYear', + :'country_code' => :'countryCode', + :'email' => :'email', + :'address' => :'address', + :'city' => :'city', + :'state' => :'state', + :'zip' => :'zip', + :'foreign_province' => :'foreignProvince', + :'transfer_agent_name' => :'transferAgentName', + :'last_filing' => :'lastFiling' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'name' => :'String', + :'dba_name' => :'String', + :'tin' => :'String', + :'reference_id' => :'String', + :'telephone' => :'String', + :'tax_year' => :'Integer', + :'country_code' => :'String', + :'email' => :'String', + :'address' => :'String', + :'city' => :'String', + :'state' => :'String', + :'zip' => :'String', + :'foreign_province' => :'String', + :'transfer_agent_name' => :'String', + :'last_filing' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'name', + :'dba_name', + :'tin', + :'reference_id', + :'telephone', + :'tax_year', + :'country_code', + :'email', + :'address', + :'city', + :'state', + :'zip', + :'foreign_province', + :'transfer_agent_name', + :'last_filing' + ]) + end + + # List of class defined in allOf (OpenAPI v3) + def self.openapi_all_of + [ + :'IssuerBase' + ] + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::IssuerRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `AvalaraSdk::A1099::V2::IssuerRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'name') + self.name = attributes[:'name'] + else + self.name = nil + end + + if attributes.key?(:'dba_name') + self.dba_name = attributes[:'dba_name'] + end + + if attributes.key?(:'tin') + self.tin = attributes[:'tin'] + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'telephone') + self.telephone = attributes[:'telephone'] + else + self.telephone = nil + end + + if attributes.key?(:'tax_year') + self.tax_year = attributes[:'tax_year'] + else + self.tax_year = nil + end + + if attributes.key?(:'country_code') + self.country_code = attributes[:'country_code'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + else + self.email = nil + end + + if attributes.key?(:'address') + self.address = attributes[:'address'] + else + self.address = nil + end + + if attributes.key?(:'city') + self.city = attributes[:'city'] + else + self.city = nil + end + + if attributes.key?(:'state') + self.state = attributes[:'state'] + else + self.state = nil + end + + if attributes.key?(:'zip') + self.zip = attributes[:'zip'] + else + self.zip = nil + end + + if attributes.key?(:'foreign_province') + self.foreign_province = attributes[:'foreign_province'] + end + + if attributes.key?(:'transfer_agent_name') + self.transfer_agent_name = attributes[:'transfer_agent_name'] + end + + if attributes.key?(:'last_filing') + self.last_filing = attributes[:'last_filing'] + else + self.last_filing = nil + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + warn '[DEPRECATED] the `valid?` method is obsolete' + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + name == o.name && + dba_name == o.dba_name && + tin == o.tin && + reference_id == o.reference_id && + telephone == o.telephone && + tax_year == o.tax_year && + country_code == o.country_code && + email == o.email && + address == o.address && + city == o.city && + state == o.state && + zip == o.zip && + foreign_province == o.foreign_province && + transfer_agent_name == o.transfer_agent_name && + last_filing == o.last_filing + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [name, dba_name, tin, reference_id, telephone, tax_year, country_code, email, address, city, state, zip, foreign_province, transfer_agent_name, last_filing].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + transformed_hash = {} + openapi_types.each_pair do |key, type| + if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = nil + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } + end + elsif !attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) + end + end + new(transformed_hash) + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def self._deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = AvalaraSdk::A1099::V2.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/avalara_sdk/models/A1099/V2/issuer_response.rb b/lib/avalara_sdk/models/A1099/V2/issuer_response.rb index 7edc031..85b4409 100644 --- a/lib/avalara_sdk/models/A1099/V2/issuer_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/issuer_response.rb @@ -142,7 +142,7 @@ def self.openapi_nullable # List of class defined in allOf (OpenAPI v3) def self.openapi_all_of [ - :'IssuerCommand' + :'IssuerBase' ] end diff --git a/lib/avalara_sdk/models/A1099/V2/job_response.rb b/lib/avalara_sdk/models/A1099/V2/job_response.rb index ed2c1f2..6984d4f 100644 --- a/lib/avalara_sdk/models/A1099/V2/job_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/job_response.rb @@ -285,12 +285,6 @@ def status=(status) @status = status end - # Custom attribute writer method with validation - # @param [Object] processed_forms Value to be assigned - def processed_forms=(processed_forms) - @processed_forms = processed_forms - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/validation_error.rb b/lib/avalara_sdk/models/A1099/V2/validation_error.rb index b3fecea..d2012f4 100644 --- a/lib/avalara_sdk/models/A1099/V2/validation_error.rb +++ b/lib/avalara_sdk/models/A1099/V2/validation_error.rb @@ -87,12 +87,6 @@ def valid? true end - # Custom attribute writer method with validation - # @param [Object] errors Value to be assigned - def errors=(errors) - @errors = errors - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb b/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb index bceb10f..505c6ed 100644 --- a/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb @@ -26,7 +26,7 @@ class W4FormMinimalRequest # The office code associated with the form. attr_accessor :office_code - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -143,8 +143,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -181,14 +179,6 @@ def list_invalid_properties invalid_properties.push('invalid value for "employee_last_name", the character length must be great than or equal to 1.') end - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') - end - - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') - end - invalid_properties end @@ -204,8 +194,6 @@ def valid? return false if @employee_first_name.to_s.length < 1 return false if @employee_last_name.nil? return false if @employee_last_name.to_s.length < 1 - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 true end @@ -261,20 +249,6 @@ def employee_last_name=(employee_last_name) @employee_last_name = employee_last_name end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb b/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb index 63fd7da..9d3c69b 100644 --- a/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb @@ -26,25 +26,25 @@ class W4FormRequest # The name suffix of the employee. attr_accessor :employee_name_suffix - # The type of TIN provided. + # Tax Identification Number (TIN) type. attr_accessor :tin_type # The taxpayer identification number (TIN). attr_accessor :tin - # The address of the employee. + # The address of the employee. Required unless exempt. attr_accessor :address - # The city of residence of the employee. + # The city of residence of the employee. Required unless exempt. attr_accessor :city - # The state of residence of the employee. + # The state of residence of the employee. Required unless exempt. attr_accessor :state - # The ZIP code of residence of the employee. + # The ZIP code of residence of the employee. Required unless exempt. attr_accessor :zip - # The marital status of the employee. + # 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. attr_accessor :marital_status # Indicates whether the last name differs from prior records. @@ -77,7 +77,7 @@ class W4FormRequest # The signature of the form. attr_accessor :signature - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -226,6 +226,8 @@ def initialize(attributes = {}) if attributes.key?(:'employee_first_name') self.employee_first_name = attributes[:'employee_first_name'] + else + self.employee_first_name = nil end if attributes.key?(:'employee_middle_name') @@ -234,6 +236,8 @@ def initialize(attributes = {}) if attributes.key?(:'employee_last_name') self.employee_last_name = attributes[:'employee_last_name'] + else + self.employee_last_name = nil end if attributes.key?(:'employee_name_suffix') @@ -242,10 +246,14 @@ def initialize(attributes = {}) if attributes.key?(:'tin_type') self.tin_type = attributes[:'tin_type'] + else + self.tin_type = nil end if attributes.key?(:'tin') self.tin = attributes[:'tin'] + else + self.tin = nil end if attributes.key?(:'address') @@ -310,8 +318,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -328,12 +334,20 @@ def initialize(attributes = {}) def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') + if @employee_first_name.nil? + invalid_properties.push('invalid value for "employee_first_name", employee_first_name cannot be nil.') + end + + if @employee_last_name.nil? + invalid_properties.push('invalid value for "employee_last_name", employee_last_name cannot be nil.') end - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') + if @tin_type.nil? + invalid_properties.push('invalid value for "tin_type", tin_type cannot be nil.') + end + + if @tin.nil? + invalid_properties.push('invalid value for "tin", tin cannot be nil.') end invalid_properties @@ -345,8 +359,10 @@ def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) return false unless type_validator.valid?(@type) - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 + return false if @employee_first_name.nil? + return false if @employee_last_name.nil? + return false if @tin_type.nil? + return false if @tin.nil? true end @@ -360,20 +376,6 @@ def type=(type) @type = type end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb b/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb index 09e0c61..51ac0c8 100644 --- a/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb @@ -10,7 +10,10 @@ require 'time' module AvalaraSdk::A1099::V2 - class W4FormResponse < W9FormBaseResponse + class W4FormResponse + # The form type (always \"W4\" for this model). + attr_accessor :type + # The first name of the employee. attr_accessor :employee_first_name @@ -23,7 +26,7 @@ class W4FormResponse < W9FormBaseResponse # The name suffix of the employee. attr_accessor :employee_name_suffix - # The type of TIN provided. + # Tax Identification Number (TIN) type. attr_accessor :tin_type # The taxpayer identification number (TIN). @@ -68,9 +71,71 @@ class W4FormResponse < W9FormBaseResponse # The office code associated with the form. attr_accessor :office_code + # The unique identifier for the form. + attr_accessor :id + + # The entry status information for the form. + attr_accessor :entry_status + + # A reference identifier for the form. + attr_accessor :reference_id + + # The ID of the associated company. + attr_accessor :company_id + + # The display name associated with the form. + attr_accessor :display_name + + # The email address of the individual associated with the form. + attr_accessor :email + + # Indicates whether the form is archived. + attr_accessor :archived + + # Form ID of previous version. + attr_accessor :ancestor_id + + # The signature of the form. + attr_accessor :signature + + # The date the form was signed. + attr_accessor :signed_date + + # The date when e-delivery was consented. + attr_accessor :e_delivery_consented_at + + # The creation date of the form. + attr_accessor :created_at + + # The last updated date of the form. + attr_accessor :updated_at + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'employee_first_name' => :'employeeFirstName', :'employee_middle_name' => :'employeeMiddleName', :'employee_last_name' => :'employeeLastName', @@ -89,18 +154,32 @@ def self.attribute_map :'deductions' => :'deductions', :'additional_withheld' => :'additionalWithheld', :'exempt_from_withholding' => :'exemptFromWithholding', - :'office_code' => :'officeCode' + :'office_code' => :'officeCode', + :'id' => :'id', + :'entry_status' => :'entryStatus', + :'reference_id' => :'referenceId', + :'company_id' => :'companyId', + :'display_name' => :'displayName', + :'email' => :'email', + :'archived' => :'archived', + :'ancestor_id' => :'ancestorId', + :'signature' => :'signature', + :'signed_date' => :'signedDate', + :'e_delivery_consented_at' => :'eDeliveryConsentedAt', + :'created_at' => :'createdAt', + :'updated_at' => :'updatedAt' } end - # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + attribute_map.values end # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'employee_first_name' => :'String', :'employee_middle_name' => :'String', :'employee_last_name' => :'String', @@ -119,7 +198,20 @@ def self.openapi_types :'deductions' => :'Float', :'additional_withheld' => :'Float', :'exempt_from_withholding' => :'Boolean', - :'office_code' => :'String' + :'office_code' => :'String', + :'id' => :'String', + :'entry_status' => :'EntryStatusResponse', + :'reference_id' => :'String', + :'company_id' => :'String', + :'display_name' => :'String', + :'email' => :'String', + :'archived' => :'Boolean', + :'ancestor_id' => :'String', + :'signature' => :'String', + :'signed_date' => :'Time', + :'e_delivery_consented_at' => :'Time', + :'created_at' => :'Time', + :'updated_at' => :'Time' } end @@ -138,7 +230,13 @@ def self.openapi_nullable :'non_job_income', :'deductions', :'additional_withheld', - :'office_code' + :'office_code', + :'reference_id', + :'email', + :'ancestor_id', + :'signature', + :'signed_date', + :'e_delivery_consented_at', ]) end @@ -164,8 +262,9 @@ def initialize(attributes = {}) h[k.to_sym] = v } - # call parent's initialize - super(attributes) + if attributes.key?(:'type') + self.type = attributes[:'type'] + end if attributes.key?(:'employee_first_name') self.employee_first_name = attributes[:'employee_first_name'] @@ -242,13 +341,65 @@ def initialize(attributes = {}) if attributes.key?(:'office_code') self.office_code = attributes[:'office_code'] end + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'entry_status') + self.entry_status = attributes[:'entry_status'] + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'company_id') + self.company_id = attributes[:'company_id'] + end + + if attributes.key?(:'display_name') + self.display_name = attributes[:'display_name'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + end + + if attributes.key?(:'archived') + self.archived = attributes[:'archived'] + end + + if attributes.key?(:'ancestor_id') + self.ancestor_id = attributes[:'ancestor_id'] + end + + if attributes.key?(:'signature') + self.signature = attributes[:'signature'] + end + + if attributes.key?(:'signed_date') + self.signed_date = attributes[:'signed_date'] + end + + if attributes.key?(:'e_delivery_consented_at') + self.e_delivery_consented_at = attributes[:'e_delivery_consented_at'] + end + + if attributes.key?(:'created_at') + self.created_at = attributes[:'created_at'] + end + + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' - invalid_properties = super + invalid_properties = Array.new invalid_properties end @@ -256,7 +407,19 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - true && super + type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + return false unless type_validator.valid?(@type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type end # Checks equality by comparing each attribute. @@ -264,6 +427,7 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && employee_first_name == o.employee_first_name && employee_middle_name == o.employee_middle_name && employee_last_name == o.employee_last_name && @@ -282,7 +446,20 @@ def ==(o) deductions == o.deductions && additional_withheld == o.additional_withheld && exempt_from_withholding == o.exempt_from_withholding && - office_code == o.office_code && super(o) + office_code == o.office_code && + id == o.id && + entry_status == o.entry_status && + reference_id == o.reference_id && + company_id == o.company_id && + display_name == o.display_name && + email == o.email && + archived == o.archived && + ancestor_id == o.ancestor_id && + signature == o.signature && + signed_date == o.signed_date && + e_delivery_consented_at == o.e_delivery_consented_at && + created_at == o.created_at && + updated_at == o.updated_at end # @see the `==` method @@ -294,7 +471,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [employee_first_name, employee_middle_name, employee_last_name, employee_name_suffix, tin_type, tin, address, city, state, zip, marital_status, last_name_differs, num_allowances, other_dependents, non_job_income, deductions, additional_withheld, exempt_from_withholding, office_code].hash + [type, employee_first_name, employee_middle_name, employee_last_name, employee_name_suffix, tin_type, tin, address, city, state, zip, marital_status, last_name_differs, num_allowances, other_dependents, non_job_income, deductions, additional_withheld, exempt_from_withholding, office_code, id, entry_status, reference_id, company_id, display_name, email, archived, ancestor_id, signature, signed_date, e_delivery_consented_at, created_at, updated_at].hash end # Builds the object from hash @@ -302,7 +479,6 @@ def hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) - super(attributes) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| @@ -379,7 +555,7 @@ def to_body # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash - hash = super + hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? diff --git a/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb b/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb index 7ce8d17..d88e214 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb @@ -23,7 +23,7 @@ class W8BenEFormMinimalRequest # A reference number for the form. attr_accessor :reference_number - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -132,8 +132,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -162,14 +160,6 @@ def list_invalid_properties invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.') end - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') - end - - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') - end - invalid_properties end @@ -183,8 +173,6 @@ def valid? return false if @email.to_s.length < 1 return false if @name.nil? return false if @name.to_s.length < 1 - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 true end @@ -226,20 +214,6 @@ def name=(name) @name = name end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb b/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb index 7413126..e6a7e11 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb @@ -23,13 +23,13 @@ class W8BenEFormRequest # The name of the disregarded entity receiving the payment (if applicable). attr_accessor :disregarded_entity - # The entity type. + # 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 attr_accessor :entity_type # Indicates whether the entity is making a treaty claim. attr_accessor :making_treaty_claim - # The FATCA status. + # 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 attr_accessor :fatca_status # The residential address of the individual or entity. @@ -80,7 +80,7 @@ class W8BenEFormRequest # A reference number for the form. attr_accessor :reference_number - # The FATCA status of disregarded entity or branch receiving payment. + # 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 attr_accessor :disregarded_entity_fatca_status # The address for disregarded entities. @@ -110,7 +110,7 @@ class W8BenEFormRequest # Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. attr_accessor :benefit_limitation_certification - # The benefit limitation for tax treaty claims. + # 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 attr_accessor :benefit_limitation # Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. @@ -182,7 +182,7 @@ class W8BenEFormRequest # The country for the applicable IGA with the United States. attr_accessor :iga_country - # The applicable IGA model. + # The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA attr_accessor :iga_model # Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. @@ -305,7 +305,7 @@ class W8BenEFormRequest # The signature of the form. attr_accessor :signature - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -678,10 +678,14 @@ def initialize(attributes = {}) if attributes.key?(:'name') self.name = attributes[:'name'] + else + self.name = nil end if attributes.key?(:'citizenship_country') self.citizenship_country = attributes[:'citizenship_country'] + else + self.citizenship_country = nil end if attributes.key?(:'disregarded_entity') @@ -690,6 +694,8 @@ def initialize(attributes = {}) if attributes.key?(:'entity_type') self.entity_type = attributes[:'entity_type'] + else + self.entity_type = nil end if attributes.key?(:'making_treaty_claim') @@ -698,6 +704,8 @@ def initialize(attributes = {}) if attributes.key?(:'fatca_status') self.fatca_status = attributes[:'fatca_status'] + else + self.fatca_status = nil end if attributes.key?(:'residence_address') @@ -718,6 +726,8 @@ def initialize(attributes = {}) if attributes.key?(:'residence_country') self.residence_country = attributes[:'residence_country'] + else + self.residence_country = nil end if attributes.key?(:'residence_is_mailing') @@ -1068,8 +1078,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -1086,12 +1094,24 @@ def initialize(attributes = {}) def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @citizenship_country.nil? + invalid_properties.push('invalid value for "citizenship_country", citizenship_country cannot be nil.') + end + + if @entity_type.nil? + invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.') + end + + if @fatca_status.nil? + invalid_properties.push('invalid value for "fatca_status", fatca_status cannot be nil.') end - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') + if @residence_country.nil? + invalid_properties.push('invalid value for "residence_country", residence_country cannot be nil.') end invalid_properties @@ -1103,8 +1123,11 @@ def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) return false unless type_validator.valid?(@type) - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 + return false if @name.nil? + return false if @citizenship_country.nil? + return false if @entity_type.nil? + return false if @fatca_status.nil? + return false if @residence_country.nil? true end @@ -1118,20 +1141,6 @@ def type=(type) @type = type end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb b/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb index f358a28..4992216 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb @@ -10,7 +10,10 @@ require 'time' module AvalaraSdk::A1099::V2 - class W8BenEFormResponse < W9FormBaseResponse + class W8BenEFormResponse + # The form type (always \"W8BenE\" for this model). + attr_accessor :type + # The name of the individual or entity associated with the form. attr_accessor :name @@ -62,7 +65,7 @@ class W8BenEFormResponse < W9FormBaseResponse # The country of the mailing address. attr_accessor :mailing_country - # The type of TIN provided. + # Tax Identification Number (TIN) type. attr_accessor :tin_type # The taxpayer identification number (TIN). @@ -299,9 +302,71 @@ class W8BenEFormResponse < W9FormBaseResponse # Certifies signer has the capacity to sign for the beneficial owner. attr_accessor :capacity_to_sign_certification + # The unique identifier for the form. + attr_accessor :id + + # The entry status information for the form. + attr_accessor :entry_status + + # A reference identifier for the form. + attr_accessor :reference_id + + # The ID of the associated company. + attr_accessor :company_id + + # The display name associated with the form. + attr_accessor :display_name + + # The email address of the individual associated with the form. + attr_accessor :email + + # Indicates whether the form is archived. + attr_accessor :archived + + # Form ID of previous version. + attr_accessor :ancestor_id + + # The signature of the form. + attr_accessor :signature + + # The date the form was signed. + attr_accessor :signed_date + + # The date when e-delivery was consented. + attr_accessor :e_delivery_consented_at + + # The creation date of the form. + attr_accessor :created_at + + # The last updated date of the form. + attr_accessor :updated_at + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'name' => :'name', :'citizenship_country' => :'citizenshipCountry', :'disregarded_entity' => :'disregardedEntity', @@ -397,18 +462,32 @@ def self.attribute_map :'direct_reporting_nffe_sponsoring_entity' => :'directReportingNffeSponsoringEntity', :'substantial_us_owners' => :'substantialUsOwners', :'signer_name' => :'signerName', - :'capacity_to_sign_certification' => :'capacityToSignCertification' + :'capacity_to_sign_certification' => :'capacityToSignCertification', + :'id' => :'id', + :'entry_status' => :'entryStatus', + :'reference_id' => :'referenceId', + :'company_id' => :'companyId', + :'display_name' => :'displayName', + :'email' => :'email', + :'archived' => :'archived', + :'ancestor_id' => :'ancestorId', + :'signature' => :'signature', + :'signed_date' => :'signedDate', + :'e_delivery_consented_at' => :'eDeliveryConsentedAt', + :'created_at' => :'createdAt', + :'updated_at' => :'updatedAt' } end - # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + attribute_map.values end # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'name' => :'String', :'citizenship_country' => :'String', :'disregarded_entity' => :'String', @@ -504,7 +583,20 @@ def self.openapi_types :'direct_reporting_nffe_sponsoring_entity' => :'String', :'substantial_us_owners' => :'Array', :'signer_name' => :'String', - :'capacity_to_sign_certification' => :'Boolean' + :'capacity_to_sign_certification' => :'Boolean', + :'id' => :'String', + :'entry_status' => :'EntryStatusResponse', + :'reference_id' => :'String', + :'company_id' => :'String', + :'display_name' => :'String', + :'email' => :'String', + :'archived' => :'Boolean', + :'ancestor_id' => :'String', + :'signature' => :'String', + :'signed_date' => :'Time', + :'e_delivery_consented_at' => :'Time', + :'created_at' => :'Time', + :'updated_at' => :'Time' } end @@ -551,6 +643,12 @@ def self.openapi_nullable :'nffe_affiliate_of_publicly_traded_entity_securities_market', :'direct_reporting_nffe_sponsoring_entity', :'signer_name', + :'reference_id', + :'email', + :'ancestor_id', + :'signature', + :'signed_date', + :'e_delivery_consented_at', ]) end @@ -576,8 +674,9 @@ def initialize(attributes = {}) h[k.to_sym] = v } - # call parent's initialize - super(attributes) + if attributes.key?(:'type') + self.type = attributes[:'type'] + end if attributes.key?(:'name') self.name = attributes[:'name'] @@ -964,13 +1063,65 @@ def initialize(attributes = {}) if attributes.key?(:'capacity_to_sign_certification') self.capacity_to_sign_certification = attributes[:'capacity_to_sign_certification'] end + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'entry_status') + self.entry_status = attributes[:'entry_status'] + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'company_id') + self.company_id = attributes[:'company_id'] + end + + if attributes.key?(:'display_name') + self.display_name = attributes[:'display_name'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + end + + if attributes.key?(:'archived') + self.archived = attributes[:'archived'] + end + + if attributes.key?(:'ancestor_id') + self.ancestor_id = attributes[:'ancestor_id'] + end + + if attributes.key?(:'signature') + self.signature = attributes[:'signature'] + end + + if attributes.key?(:'signed_date') + self.signed_date = attributes[:'signed_date'] + end + + if attributes.key?(:'e_delivery_consented_at') + self.e_delivery_consented_at = attributes[:'e_delivery_consented_at'] + end + + if attributes.key?(:'created_at') + self.created_at = attributes[:'created_at'] + end + + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' - invalid_properties = super + invalid_properties = Array.new invalid_properties end @@ -978,7 +1129,19 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - true && super + type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + return false unless type_validator.valid?(@type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type end # Checks equality by comparing each attribute. @@ -986,6 +1149,7 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && name == o.name && citizenship_country == o.citizenship_country && disregarded_entity == o.disregarded_entity && @@ -1081,7 +1245,20 @@ def ==(o) direct_reporting_nffe_sponsoring_entity == o.direct_reporting_nffe_sponsoring_entity && substantial_us_owners == o.substantial_us_owners && signer_name == o.signer_name && - capacity_to_sign_certification == o.capacity_to_sign_certification && super(o) + capacity_to_sign_certification == o.capacity_to_sign_certification && + id == o.id && + entry_status == o.entry_status && + reference_id == o.reference_id && + company_id == o.company_id && + display_name == o.display_name && + email == o.email && + archived == o.archived && + ancestor_id == o.ancestor_id && + signature == o.signature && + signed_date == o.signed_date && + e_delivery_consented_at == o.e_delivery_consented_at && + created_at == o.created_at && + updated_at == o.updated_at end # @see the `==` method @@ -1093,7 +1270,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [name, citizenship_country, disregarded_entity, entity_type, making_treaty_claim, fatca_status, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, giin, foreign_tin_not_required, foreign_tin, reference_number, disregarded_entity_fatca_status, disregarded_address, disregarded_city, disregarded_state, disregarded_zip, disregarded_country, disregarded_entity_giin, treaty_country_certification, treaty_country, benefit_limitation_certification, benefit_limitation, qualified_resident_status_certification, treaty_article, withholding_rate, income_type, treaty_reasons, ffi_sponsoring_entity, investment_entity_certification, controlled_foreign_corporation_certification, compliant_nonregistering_local_bank_certification, compliant_ffi_low_value_accounts_certification, sponsored_closely_held_entity_sponsoring_entity, sponsored_closely_held_investment_vehicle_certification, compliant_limited_life_debt_entity_certification, investment_entity_no_financial_accounts_certification, owner_documented_ffi_certification, owner_documented_ffi_reporting_statement_certification, owner_documented_ffi_auditor_letter_certification, owner_documented_ffi_trust_beneficiaries_certification, restricted_distributor_certification, restricted_distributor_agreement_certification, restricted_distributor_preexisting_sales_compliance_certification, nonreporting_iga_ffi_certification, iga_country, iga_model, iga_legal_status_treatment, iga_ffi_trustee_or_sponsor, iga_ffi_trustee_is_foreign, non_commercial_financial_activity_certification, internation_organization_certification, intergovernmental_organization_certification, treaty_qualified_pension_fund_certification, qualified_retirement_fund_certification, narrow_participation_retirement_fund_certification, section401_a_equivalent_pension_plan_certification, investment_entity_for_retirement_funds_certification, exempt_beneficial_owner_sponsored_retirement_fund_certification, exempt_beneficial_owner_owned_investment_entity_certification, territory_financial_institution_certification, excepted_nonfinancial_group_entity_certification, excepted_nonfinancial_start_up_certification, startup_formation_or_resolution_date, excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification, nonfinancial_entity_filing_date, section501_c_organization_certification, determination_letter_date, nonprofit_organization_certification, publicly_traded_nffe_certification, publicly_traded_nffe_securities_market, nffe_affiliate_of_publicly_traded_entity_certification, publicly_traded_entity, nffe_affiliate_of_publicly_traded_entity_securities_market, excepted_territory_nffe_certification, active_nffe_certification, passive_nffe_certification, passive_nffe_no_substantial_us_owners_certification, passive_nffe_substantial_us_owners_provided_certification, excepted_inter_affiliate_ffi_certification, sponsored_direct_reporting_nffe_certification, direct_reporting_nffe_sponsoring_entity, substantial_us_owners, signer_name, capacity_to_sign_certification].hash + [type, name, citizenship_country, disregarded_entity, entity_type, making_treaty_claim, fatca_status, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, giin, foreign_tin_not_required, foreign_tin, reference_number, disregarded_entity_fatca_status, disregarded_address, disregarded_city, disregarded_state, disregarded_zip, disregarded_country, disregarded_entity_giin, treaty_country_certification, treaty_country, benefit_limitation_certification, benefit_limitation, qualified_resident_status_certification, treaty_article, withholding_rate, income_type, treaty_reasons, ffi_sponsoring_entity, investment_entity_certification, controlled_foreign_corporation_certification, compliant_nonregistering_local_bank_certification, compliant_ffi_low_value_accounts_certification, sponsored_closely_held_entity_sponsoring_entity, sponsored_closely_held_investment_vehicle_certification, compliant_limited_life_debt_entity_certification, investment_entity_no_financial_accounts_certification, owner_documented_ffi_certification, owner_documented_ffi_reporting_statement_certification, owner_documented_ffi_auditor_letter_certification, owner_documented_ffi_trust_beneficiaries_certification, restricted_distributor_certification, restricted_distributor_agreement_certification, restricted_distributor_preexisting_sales_compliance_certification, nonreporting_iga_ffi_certification, iga_country, iga_model, iga_legal_status_treatment, iga_ffi_trustee_or_sponsor, iga_ffi_trustee_is_foreign, non_commercial_financial_activity_certification, internation_organization_certification, intergovernmental_organization_certification, treaty_qualified_pension_fund_certification, qualified_retirement_fund_certification, narrow_participation_retirement_fund_certification, section401_a_equivalent_pension_plan_certification, investment_entity_for_retirement_funds_certification, exempt_beneficial_owner_sponsored_retirement_fund_certification, exempt_beneficial_owner_owned_investment_entity_certification, territory_financial_institution_certification, excepted_nonfinancial_group_entity_certification, excepted_nonfinancial_start_up_certification, startup_formation_or_resolution_date, excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification, nonfinancial_entity_filing_date, section501_c_organization_certification, determination_letter_date, nonprofit_organization_certification, publicly_traded_nffe_certification, publicly_traded_nffe_securities_market, nffe_affiliate_of_publicly_traded_entity_certification, publicly_traded_entity, nffe_affiliate_of_publicly_traded_entity_securities_market, excepted_territory_nffe_certification, active_nffe_certification, passive_nffe_certification, passive_nffe_no_substantial_us_owners_certification, passive_nffe_substantial_us_owners_provided_certification, excepted_inter_affiliate_ffi_certification, sponsored_direct_reporting_nffe_certification, direct_reporting_nffe_sponsoring_entity, substantial_us_owners, signer_name, capacity_to_sign_certification, id, entry_status, reference_id, company_id, display_name, email, archived, ancestor_id, signature, signed_date, e_delivery_consented_at, created_at, updated_at].hash end # Builds the object from hash @@ -1101,7 +1278,6 @@ def hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) - super(attributes) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| @@ -1178,7 +1354,7 @@ def to_body # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash - hash = super + hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? diff --git a/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb b/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb index 3b8c4e5..146db5f 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb @@ -23,7 +23,7 @@ class W8BenFormMinimalRequest # A reference number for the form. attr_accessor :reference_number - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -132,8 +132,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -162,14 +160,6 @@ def list_invalid_properties invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.') end - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') - end - - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') - end - invalid_properties end @@ -183,8 +173,6 @@ def valid? return false if @email.to_s.length < 1 return false if @name.nil? return false if @name.to_s.length < 1 - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 true end @@ -226,20 +214,6 @@ def name=(name) @name = name end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb b/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb index 56acfcb..400a60d 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb @@ -92,7 +92,7 @@ class W8BenFormRequest # The signature of the form. attr_accessor :signature - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -253,10 +253,14 @@ def initialize(attributes = {}) if attributes.key?(:'name') self.name = attributes[:'name'] + else + self.name = nil end if attributes.key?(:'citizenship_country') self.citizenship_country = attributes[:'citizenship_country'] + else + self.citizenship_country = nil end if attributes.key?(:'residence_address') @@ -277,6 +281,8 @@ def initialize(attributes = {}) if attributes.key?(:'residence_country') self.residence_country = attributes[:'residence_country'] + else + self.residence_country = nil end if attributes.key?(:'residence_is_mailing') @@ -301,6 +307,8 @@ def initialize(attributes = {}) if attributes.key?(:'mailing_country') self.mailing_country = attributes[:'mailing_country'] + else + self.mailing_country = nil end if attributes.key?(:'tin') @@ -357,8 +365,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -375,12 +381,16 @@ def initialize(attributes = {}) def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @citizenship_country.nil? + invalid_properties.push('invalid value for "citizenship_country", citizenship_country cannot be nil.') end - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') + if @residence_country.nil? + invalid_properties.push('invalid value for "residence_country", residence_country cannot be nil.') end invalid_properties @@ -392,8 +402,9 @@ def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) return false unless type_validator.valid?(@type) - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 + return false if @name.nil? + return false if @citizenship_country.nil? + return false if @residence_country.nil? true end @@ -407,20 +418,6 @@ def type=(type) @type = type end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb b/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb index ed93271..cc72d90 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb @@ -10,7 +10,10 @@ require 'time' module AvalaraSdk::A1099::V2 - class W8BenFormResponse < W9FormBaseResponse + class W8BenFormResponse + # The form type (always \"W8Ben\" for this model). + attr_accessor :type + # The name of the individual or entity associated with the form. attr_accessor :name @@ -50,7 +53,7 @@ class W8BenFormResponse < W9FormBaseResponse # The country of the mailing address. attr_accessor :mailing_country - # The type of TIN provided. + # Tax Identification Number (TIN) type. attr_accessor :tin_type # The taxpayer identification number (TIN). @@ -89,9 +92,71 @@ class W8BenFormResponse < W9FormBaseResponse # The capacity in which the signer is signing the form. attr_accessor :signer_capacity + # The unique identifier for the form. + attr_accessor :id + + # The entry status information for the form. + attr_accessor :entry_status + + # A reference identifier for the form. + attr_accessor :reference_id + + # The ID of the associated company. + attr_accessor :company_id + + # The display name associated with the form. + attr_accessor :display_name + + # The email address of the individual associated with the form. + attr_accessor :email + + # Indicates whether the form is archived. + attr_accessor :archived + + # Form ID of previous version. + attr_accessor :ancestor_id + + # The signature of the form. + attr_accessor :signature + + # The date the form was signed. + attr_accessor :signed_date + + # The date when e-delivery was consented. + attr_accessor :e_delivery_consented_at + + # The creation date of the form. + attr_accessor :created_at + + # The last updated date of the form. + attr_accessor :updated_at + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'name' => :'name', :'citizenship_country' => :'citizenshipCountry', :'residence_address' => :'residenceAddress', @@ -117,18 +182,32 @@ def self.attribute_map :'withholding_rate' => :'withholdingRate', :'income_type' => :'incomeType', :'signer_name' => :'signerName', - :'signer_capacity' => :'signerCapacity' + :'signer_capacity' => :'signerCapacity', + :'id' => :'id', + :'entry_status' => :'entryStatus', + :'reference_id' => :'referenceId', + :'company_id' => :'companyId', + :'display_name' => :'displayName', + :'email' => :'email', + :'archived' => :'archived', + :'ancestor_id' => :'ancestorId', + :'signature' => :'signature', + :'signed_date' => :'signedDate', + :'e_delivery_consented_at' => :'eDeliveryConsentedAt', + :'created_at' => :'createdAt', + :'updated_at' => :'updatedAt' } end - # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + attribute_map.values end # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'name' => :'String', :'citizenship_country' => :'String', :'residence_address' => :'String', @@ -154,7 +233,20 @@ def self.openapi_types :'withholding_rate' => :'String', :'income_type' => :'String', :'signer_name' => :'String', - :'signer_capacity' => :'String' + :'signer_capacity' => :'String', + :'id' => :'String', + :'entry_status' => :'EntryStatusResponse', + :'reference_id' => :'String', + :'company_id' => :'String', + :'display_name' => :'String', + :'email' => :'String', + :'archived' => :'Boolean', + :'ancestor_id' => :'String', + :'signature' => :'String', + :'signed_date' => :'Time', + :'e_delivery_consented_at' => :'Time', + :'created_at' => :'Time', + :'updated_at' => :'Time' } end @@ -177,7 +269,13 @@ def self.openapi_nullable :'withholding_rate', :'income_type', :'signer_name', - :'signer_capacity' + :'signer_capacity', + :'reference_id', + :'email', + :'ancestor_id', + :'signature', + :'signed_date', + :'e_delivery_consented_at', ]) end @@ -203,8 +301,9 @@ def initialize(attributes = {}) h[k.to_sym] = v } - # call parent's initialize - super(attributes) + if attributes.key?(:'type') + self.type = attributes[:'type'] + end if attributes.key?(:'name') self.name = attributes[:'name'] @@ -309,13 +408,65 @@ def initialize(attributes = {}) if attributes.key?(:'signer_capacity') self.signer_capacity = attributes[:'signer_capacity'] end + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'entry_status') + self.entry_status = attributes[:'entry_status'] + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'company_id') + self.company_id = attributes[:'company_id'] + end + + if attributes.key?(:'display_name') + self.display_name = attributes[:'display_name'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + end + + if attributes.key?(:'archived') + self.archived = attributes[:'archived'] + end + + if attributes.key?(:'ancestor_id') + self.ancestor_id = attributes[:'ancestor_id'] + end + + if attributes.key?(:'signature') + self.signature = attributes[:'signature'] + end + + if attributes.key?(:'signed_date') + self.signed_date = attributes[:'signed_date'] + end + + if attributes.key?(:'e_delivery_consented_at') + self.e_delivery_consented_at = attributes[:'e_delivery_consented_at'] + end + + if attributes.key?(:'created_at') + self.created_at = attributes[:'created_at'] + end + + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' - invalid_properties = super + invalid_properties = Array.new invalid_properties end @@ -323,7 +474,19 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - true && super + type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + return false unless type_validator.valid?(@type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type end # Checks equality by comparing each attribute. @@ -331,6 +494,7 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && name == o.name && citizenship_country == o.citizenship_country && residence_address == o.residence_address && @@ -356,7 +520,20 @@ def ==(o) withholding_rate == o.withholding_rate && income_type == o.income_type && signer_name == o.signer_name && - signer_capacity == o.signer_capacity && super(o) + signer_capacity == o.signer_capacity && + id == o.id && + entry_status == o.entry_status && + reference_id == o.reference_id && + company_id == o.company_id && + display_name == o.display_name && + email == o.email && + archived == o.archived && + ancestor_id == o.ancestor_id && + signature == o.signature && + signed_date == o.signed_date && + e_delivery_consented_at == o.e_delivery_consented_at && + created_at == o.created_at && + updated_at == o.updated_at end # @see the `==` method @@ -368,7 +545,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [name, citizenship_country, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, foreign_tin_not_required, foreign_tin, reference_number, birthday, treaty_country, treaty_article, treaty_reasons, withholding_rate, income_type, signer_name, signer_capacity].hash + [type, name, citizenship_country, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, foreign_tin_not_required, foreign_tin, reference_number, birthday, treaty_country, treaty_article, treaty_reasons, withholding_rate, income_type, signer_name, signer_capacity, id, entry_status, reference_id, company_id, display_name, email, archived, ancestor_id, signature, signed_date, e_delivery_consented_at, created_at, updated_at].hash end # Builds the object from hash @@ -376,7 +553,6 @@ def hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) - super(attributes) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| @@ -453,7 +629,7 @@ def to_body # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash - hash = super + hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? diff --git a/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb b/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb index 4821407..7ab72d6 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb @@ -23,7 +23,7 @@ class W8ImyFormMinimalRequest # A reference number for the form. attr_accessor :reference_number - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -132,8 +132,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -162,14 +160,6 @@ def list_invalid_properties invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.') end - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') - end - - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') - end - invalid_properties end @@ -183,8 +173,6 @@ def valid? return false if @email.to_s.length < 1 return false if @name.nil? return false if @name.to_s.length < 1 - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 true end @@ -226,20 +214,6 @@ def name=(name) @name = name end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb b/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb index 89d21ef..5179806 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb @@ -23,10 +23,10 @@ class W8ImyFormRequest # The name of the disregarded entity receiving the payment (if applicable). attr_accessor :disregarded_entity - # The entity type. + # 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. attr_accessor :entity_type - # The FATCA status. + # 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. attr_accessor :fatca_status # The residential address of the individual or entity. @@ -62,7 +62,7 @@ class W8ImyFormRequest # The country of the mailing address. attr_accessor :mailing_country - # The type of TIN provided. + # 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 attr_accessor :tin_type # The taxpayer identification number (TIN). @@ -77,7 +77,7 @@ class W8ImyFormRequest # A reference number for the form. attr_accessor :reference_number - # The FATCA status of disregarded entity or branch receiving payment. + # 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 attr_accessor :disregarded_entity_fatca_status # The address for disregarded entities. @@ -269,7 +269,7 @@ class W8ImyFormRequest # The country for the applicable IGA with the United States. attr_accessor :iga_country - # The applicable IGA model. + # The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA attr_accessor :iga_model # Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. @@ -353,7 +353,7 @@ class W8ImyFormRequest # The signature of the form. attr_accessor :signature - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -775,10 +775,14 @@ def initialize(attributes = {}) if attributes.key?(:'name') self.name = attributes[:'name'] + else + self.name = nil end if attributes.key?(:'citizenship_country') self.citizenship_country = attributes[:'citizenship_country'] + else + self.citizenship_country = nil end if attributes.key?(:'disregarded_entity') @@ -787,6 +791,8 @@ def initialize(attributes = {}) if attributes.key?(:'entity_type') self.entity_type = attributes[:'entity_type'] + else + self.entity_type = nil end if attributes.key?(:'fatca_status') @@ -811,6 +817,8 @@ def initialize(attributes = {}) if attributes.key?(:'residence_country') self.residence_country = attributes[:'residence_country'] + else + self.residence_country = nil end if attributes.key?(:'residence_is_mailing') @@ -1227,8 +1235,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -1245,12 +1251,20 @@ def initialize(attributes = {}) def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @citizenship_country.nil? + invalid_properties.push('invalid value for "citizenship_country", citizenship_country cannot be nil.') end - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') + if @entity_type.nil? + invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.') + end + + if @residence_country.nil? + invalid_properties.push('invalid value for "residence_country", residence_country cannot be nil.') end invalid_properties @@ -1262,8 +1276,10 @@ def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) return false unless type_validator.valid?(@type) - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 + return false if @name.nil? + return false if @citizenship_country.nil? + return false if @entity_type.nil? + return false if @residence_country.nil? true end @@ -1277,20 +1293,6 @@ def type=(type) @type = type end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb b/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb index a57b2ff..d2db479 100644 --- a/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb @@ -10,7 +10,10 @@ require 'time' module AvalaraSdk::A1099::V2 - class W8ImyFormResponse < W9FormBaseResponse + class W8ImyFormResponse + # The form type (always \"W8Imy\" for this model). + attr_accessor :type + # The name of the individual or entity associated with the form. attr_accessor :name @@ -59,7 +62,7 @@ class W8ImyFormResponse < W9FormBaseResponse # The country of the mailing address. attr_accessor :mailing_country - # The type of TIN provided. + # Tax Identification Number (TIN) type. attr_accessor :tin_type # The taxpayer identification number (TIN). @@ -344,9 +347,71 @@ class W8ImyFormResponse < W9FormBaseResponse # The name of the signer. attr_accessor :signer_name + # The unique identifier for the form. + attr_accessor :id + + # The entry status information for the form. + attr_accessor :entry_status + + # A reference identifier for the form. + attr_accessor :reference_id + + # The ID of the associated company. + attr_accessor :company_id + + # The display name associated with the form. + attr_accessor :display_name + + # The email address of the individual associated with the form. + attr_accessor :email + + # Indicates whether the form is archived. + attr_accessor :archived + + # Form ID of previous version. + attr_accessor :ancestor_id + + # The signature of the form. + attr_accessor :signature + + # The date the form was signed. + attr_accessor :signed_date + + # The date when e-delivery was consented. + attr_accessor :e_delivery_consented_at + + # The creation date of the form. + attr_accessor :created_at + + # The last updated date of the form. + attr_accessor :updated_at + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'name' => :'name', :'citizenship_country' => :'citizenshipCountry', :'disregarded_entity' => :'disregardedEntity', @@ -457,18 +522,32 @@ def self.attribute_map :'passive_nffe_certification' => :'passiveNffeCertification', :'sponsored_direct_reporting_nffe_certification' => :'sponsoredDirectReportingNffeCertification', :'direct_reporting_nffe_sponsoring_entity' => :'directReportingNffeSponsoringEntity', - :'signer_name' => :'signerName' + :'signer_name' => :'signerName', + :'id' => :'id', + :'entry_status' => :'entryStatus', + :'reference_id' => :'referenceId', + :'company_id' => :'companyId', + :'display_name' => :'displayName', + :'email' => :'email', + :'archived' => :'archived', + :'ancestor_id' => :'ancestorId', + :'signature' => :'signature', + :'signed_date' => :'signedDate', + :'e_delivery_consented_at' => :'eDeliveryConsentedAt', + :'created_at' => :'createdAt', + :'updated_at' => :'updatedAt' } end - # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + attribute_map.values end # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'name' => :'String', :'citizenship_country' => :'String', :'disregarded_entity' => :'String', @@ -579,7 +658,20 @@ def self.openapi_types :'passive_nffe_certification' => :'Boolean', :'sponsored_direct_reporting_nffe_certification' => :'Boolean', :'direct_reporting_nffe_sponsoring_entity' => :'String', - :'signer_name' => :'String' + :'signer_name' => :'String', + :'id' => :'String', + :'entry_status' => :'EntryStatusResponse', + :'reference_id' => :'String', + :'company_id' => :'String', + :'display_name' => :'String', + :'email' => :'String', + :'archived' => :'Boolean', + :'ancestor_id' => :'String', + :'signature' => :'String', + :'signed_date' => :'Time', + :'e_delivery_consented_at' => :'Time', + :'created_at' => :'Time', + :'updated_at' => :'Time' } end @@ -618,7 +710,13 @@ def self.openapi_nullable :'publicly_traded_entity', :'nffe_affiliate_of_publicly_traded_entity_securities_market', :'direct_reporting_nffe_sponsoring_entity', - :'signer_name' + :'signer_name', + :'reference_id', + :'email', + :'ancestor_id', + :'signature', + :'signed_date', + :'e_delivery_consented_at', ]) end @@ -644,8 +742,9 @@ def initialize(attributes = {}) h[k.to_sym] = v } - # call parent's initialize - super(attributes) + if attributes.key?(:'type') + self.type = attributes[:'type'] + end if attributes.key?(:'name') self.name = attributes[:'name'] @@ -1090,13 +1189,65 @@ def initialize(attributes = {}) if attributes.key?(:'signer_name') self.signer_name = attributes[:'signer_name'] end + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'entry_status') + self.entry_status = attributes[:'entry_status'] + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'company_id') + self.company_id = attributes[:'company_id'] + end + + if attributes.key?(:'display_name') + self.display_name = attributes[:'display_name'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + end + + if attributes.key?(:'archived') + self.archived = attributes[:'archived'] + end + + if attributes.key?(:'ancestor_id') + self.ancestor_id = attributes[:'ancestor_id'] + end + + if attributes.key?(:'signature') + self.signature = attributes[:'signature'] + end + + if attributes.key?(:'signed_date') + self.signed_date = attributes[:'signed_date'] + end + + if attributes.key?(:'e_delivery_consented_at') + self.e_delivery_consented_at = attributes[:'e_delivery_consented_at'] + end + + if attributes.key?(:'created_at') + self.created_at = attributes[:'created_at'] + end + + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' - invalid_properties = super + invalid_properties = Array.new invalid_properties end @@ -1104,7 +1255,19 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - true && super + type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + return false unless type_validator.valid?(@type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type end # Checks equality by comparing each attribute. @@ -1112,6 +1275,7 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && name == o.name && citizenship_country == o.citizenship_country && disregarded_entity == o.disregarded_entity && @@ -1222,7 +1386,20 @@ def ==(o) passive_nffe_certification == o.passive_nffe_certification && sponsored_direct_reporting_nffe_certification == o.sponsored_direct_reporting_nffe_certification && direct_reporting_nffe_sponsoring_entity == o.direct_reporting_nffe_sponsoring_entity && - signer_name == o.signer_name && super(o) + signer_name == o.signer_name && + id == o.id && + entry_status == o.entry_status && + reference_id == o.reference_id && + company_id == o.company_id && + display_name == o.display_name && + email == o.email && + archived == o.archived && + ancestor_id == o.ancestor_id && + signature == o.signature && + signed_date == o.signed_date && + e_delivery_consented_at == o.e_delivery_consented_at && + created_at == o.created_at && + updated_at == o.updated_at end # @see the `==` method @@ -1234,7 +1411,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [name, citizenship_country, disregarded_entity, entity_type, fatca_status, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, giin, foreign_tin, reference_number, disregarded_entity_fatca_status, disregarded_address, disregarded_city, disregarded_state, disregarded_zip, disregarded_country, disregarded_entity_giin, qualified_intermediary_certification, qi_primary_withholding_responsibility_certification, qi_withholding_responsibility_for_ptp_sales_certification, qi_nominee_withholding_responsibility_for_ptp_distributions_certification, qi_securities_lender_substitute_dividend_withholding_certification, qi_withholding_and1099_reporting_responsibility_certification, qi_form1099_or_fatca_reporting_responsibility_certification, qi_opt_out_of_form1099_reporting_certification, qi_withholding_rate_pool_certification, qi_intermediary_or_flow_through_entity_documentation_certification, qualified_derivatives_dealer_certification, qdd_corporation, qdd_partnership, qdd_disregarded_entity, nonqualified_intermediary_certification, nqi_withholding_statement_transmission_certification, nqi_withholding_rate_pool_compliance_certification, nqi_qualified_securities_lender_certification, nqi_alternative_withholding_statement_verification_certification, territory_financial_institution_certification, tfi_treated_as_us_person_certification, tfi_withholding_statement_transmission_certification, tfi_treated_as_us_person_for_ptp_sales_certification, tfi_nominee_us_person_for_ptp_distributions_certification, tfi_not_nominee_for_ptp_distributions_certification, us_branch_non_effectively_connected_income_certification, us_branch_agreement_to_be_treated_as_us_person_certification, us_branch_withholding_statement_and_compliance_certification, us_branch_acting_as_us_person_for_ptp_sales_certification, us_branch_nominee_for_ptp_distributions_certification, us_branch_not_nominee_for_ptp_distributions_certification, withholding_foreign_partnership_or_trust_certification, nonwithholding_foreign_entity_withholding_statement_certification, foreign_entity_partner_in_lower_tier_partnership_certification, foreign_partnership_amount_realized_section1446_f_certification, foreign_partnership_modified_amount_realized_certification, foreign_grantor_trust_amount_realized_allocation_certification, alternative_withholding_statement_reliance_certification, np_ffi_with_exempt_beneficial_owners_certification, ffi_sponsoring_entity, investment_entity_certification, controlled_foreign_corporation_certification, owner_documented_ffi_certification, owner_documented_ffi_reporting_statement_certification, owner_documented_ffi_auditor_letter_certification, compliant_nonregistering_local_bank_certification, compliant_ffi_low_value_accounts_certification, sponsored_closely_held_entity_sponsoring_entity, sponsored_closely_held_investment_vehicle_certification, compliant_limited_life_debt_entity_certification, investment_entity_no_financial_accounts_certification, restricted_distributor_certification, restricted_distributor_agreement_certification, restricted_distributor_preexisting_sales_compliance_certification, foreign_central_bank_of_issue_certification, nonreporting_iga_ffi_certification, iga_country, iga_model, iga_legal_status_treatment, iga_ffi_trustee_or_sponsor, iga_ffi_trustee_is_foreign, treaty_qualified_pension_fund_certification, qualified_retirement_fund_certification, narrow_participation_retirement_fund_certification, section401_a_equivalent_pension_plan_certification, investment_entity_for_retirement_funds_certification, exempt_beneficial_owner_sponsored_retirement_fund_certification, excepted_nonfinancial_group_entity_certification, excepted_nonfinancial_start_up_certification, startup_formation_or_resolution_date, excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification, nonfinancial_entity_filing_date, publicly_traded_nffe_certification, publicly_traded_nffe_securities_market, nffe_affiliate_of_publicly_traded_entity_certification, publicly_traded_entity, nffe_affiliate_of_publicly_traded_entity_securities_market, excepted_territory_nffe_certification, active_nffe_certification, passive_nffe_certification, sponsored_direct_reporting_nffe_certification, direct_reporting_nffe_sponsoring_entity, signer_name].hash + [type, name, citizenship_country, disregarded_entity, entity_type, fatca_status, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, giin, foreign_tin, reference_number, disregarded_entity_fatca_status, disregarded_address, disregarded_city, disregarded_state, disregarded_zip, disregarded_country, disregarded_entity_giin, qualified_intermediary_certification, qi_primary_withholding_responsibility_certification, qi_withholding_responsibility_for_ptp_sales_certification, qi_nominee_withholding_responsibility_for_ptp_distributions_certification, qi_securities_lender_substitute_dividend_withholding_certification, qi_withholding_and1099_reporting_responsibility_certification, qi_form1099_or_fatca_reporting_responsibility_certification, qi_opt_out_of_form1099_reporting_certification, qi_withholding_rate_pool_certification, qi_intermediary_or_flow_through_entity_documentation_certification, qualified_derivatives_dealer_certification, qdd_corporation, qdd_partnership, qdd_disregarded_entity, nonqualified_intermediary_certification, nqi_withholding_statement_transmission_certification, nqi_withholding_rate_pool_compliance_certification, nqi_qualified_securities_lender_certification, nqi_alternative_withholding_statement_verification_certification, territory_financial_institution_certification, tfi_treated_as_us_person_certification, tfi_withholding_statement_transmission_certification, tfi_treated_as_us_person_for_ptp_sales_certification, tfi_nominee_us_person_for_ptp_distributions_certification, tfi_not_nominee_for_ptp_distributions_certification, us_branch_non_effectively_connected_income_certification, us_branch_agreement_to_be_treated_as_us_person_certification, us_branch_withholding_statement_and_compliance_certification, us_branch_acting_as_us_person_for_ptp_sales_certification, us_branch_nominee_for_ptp_distributions_certification, us_branch_not_nominee_for_ptp_distributions_certification, withholding_foreign_partnership_or_trust_certification, nonwithholding_foreign_entity_withholding_statement_certification, foreign_entity_partner_in_lower_tier_partnership_certification, foreign_partnership_amount_realized_section1446_f_certification, foreign_partnership_modified_amount_realized_certification, foreign_grantor_trust_amount_realized_allocation_certification, alternative_withholding_statement_reliance_certification, np_ffi_with_exempt_beneficial_owners_certification, ffi_sponsoring_entity, investment_entity_certification, controlled_foreign_corporation_certification, owner_documented_ffi_certification, owner_documented_ffi_reporting_statement_certification, owner_documented_ffi_auditor_letter_certification, compliant_nonregistering_local_bank_certification, compliant_ffi_low_value_accounts_certification, sponsored_closely_held_entity_sponsoring_entity, sponsored_closely_held_investment_vehicle_certification, compliant_limited_life_debt_entity_certification, investment_entity_no_financial_accounts_certification, restricted_distributor_certification, restricted_distributor_agreement_certification, restricted_distributor_preexisting_sales_compliance_certification, foreign_central_bank_of_issue_certification, nonreporting_iga_ffi_certification, iga_country, iga_model, iga_legal_status_treatment, iga_ffi_trustee_or_sponsor, iga_ffi_trustee_is_foreign, treaty_qualified_pension_fund_certification, qualified_retirement_fund_certification, narrow_participation_retirement_fund_certification, section401_a_equivalent_pension_plan_certification, investment_entity_for_retirement_funds_certification, exempt_beneficial_owner_sponsored_retirement_fund_certification, excepted_nonfinancial_group_entity_certification, excepted_nonfinancial_start_up_certification, startup_formation_or_resolution_date, excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification, nonfinancial_entity_filing_date, publicly_traded_nffe_certification, publicly_traded_nffe_securities_market, nffe_affiliate_of_publicly_traded_entity_certification, publicly_traded_entity, nffe_affiliate_of_publicly_traded_entity_securities_market, excepted_territory_nffe_certification, active_nffe_certification, passive_nffe_certification, sponsored_direct_reporting_nffe_certification, direct_reporting_nffe_sponsoring_entity, signer_name, id, entry_status, reference_id, company_id, display_name, email, archived, ancestor_id, signature, signed_date, e_delivery_consented_at, created_at, updated_at].hash end # Builds the object from hash @@ -1242,7 +1419,6 @@ def hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) - super(attributes) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| @@ -1319,7 +1495,7 @@ def to_body # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash - hash = super + hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? diff --git a/lib/avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb b/lib/avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb index 21df9cb..255193d 100644 --- a/lib/avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb @@ -14,7 +14,7 @@ class W9FormBaseMinimalRequest # The form type. attr_accessor :type - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -99,8 +99,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -117,14 +115,6 @@ def initialize(attributes = {}) def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') - end - - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') - end - invalid_properties end @@ -134,8 +124,6 @@ def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) return false unless type_validator.valid?(@type) - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 true end @@ -149,20 +137,6 @@ def type=(type) @type = type end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb b/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb index aaeb6b5..a1eaebf 100644 --- a/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb @@ -20,7 +20,7 @@ class W9FormBaseRequest # The form type. attr_accessor :type - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -126,8 +126,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -144,14 +142,6 @@ def initialize(attributes = {}) def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') - end - - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') - end - invalid_properties end @@ -161,8 +151,6 @@ def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) return false unless type_validator.valid?(@type) - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 true end @@ -176,20 +164,6 @@ def type=(type) @type = type end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb b/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb index 6fa9fdf..361a2d3 100644 --- a/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb @@ -11,6 +11,9 @@ module AvalaraSdk::A1099::V2 class W9FormBaseResponse + # The form type. + attr_accessor :type + # The unique identifier for the form. attr_accessor :id @@ -50,12 +53,32 @@ class W9FormBaseResponse # The last updated date of the form. attr_accessor :updated_at - # The type of the response object. - attr_accessor :type + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'id' => :'id', :'entry_status' => :'entryStatus', :'reference_id' => :'referenceId', @@ -68,8 +91,7 @@ def self.attribute_map :'signed_date' => :'signedDate', :'e_delivery_consented_at' => :'eDeliveryConsentedAt', :'created_at' => :'createdAt', - :'updated_at' => :'updatedAt', - :'type' => :'type' + :'updated_at' => :'updatedAt' } end @@ -81,6 +103,7 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'id' => :'String', :'entry_status' => :'EntryStatusResponse', :'reference_id' => :'String', @@ -93,8 +116,7 @@ def self.openapi_types :'signed_date' => :'Time', :'e_delivery_consented_at' => :'Time', :'created_at' => :'Time', - :'updated_at' => :'Time', - :'type' => :'String' + :'updated_at' => :'Time' } end @@ -110,11 +132,6 @@ def self.openapi_nullable ]) end - # discriminator's property name in OpenAPI v3 - def self.openapi_discriminator_name - :'type' - end - # Initializes the object # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) @@ -130,6 +147,10 @@ def initialize(attributes = {}) h[k.to_sym] = v } + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + if attributes.key?(:'id') self.id = attributes[:'id'] end @@ -181,10 +202,6 @@ def initialize(attributes = {}) if attributes.key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end - - if attributes.key?(:'type') - self.type = attributes[:'type'] - end end # Show invalid properties with the reasons. Usually used together with valid? @@ -199,14 +216,27 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' + type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + return false unless type_validator.valid?(@type) true end + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && id == o.id && entry_status == o.entry_status && reference_id == o.reference_id && @@ -219,8 +249,7 @@ def ==(o) signed_date == o.signed_date && e_delivery_consented_at == o.e_delivery_consented_at && created_at == o.created_at && - updated_at == o.updated_at && - type == o.type + updated_at == o.updated_at end # @see the `==` method @@ -232,7 +261,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [id, entry_status, reference_id, company_id, display_name, email, archived, ancestor_id, signature, signed_date, e_delivery_consented_at, created_at, updated_at, type].hash + [type, id, entry_status, reference_id, company_id, display_name, email, archived, ancestor_id, signature, signed_date, e_delivery_consented_at, created_at, updated_at].hash end # Builds the object from hash diff --git a/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb b/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb index 4b7be15..69eee58 100644 --- a/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb @@ -23,7 +23,7 @@ class W9FormMinimalRequest # The account number associated with the form. attr_accessor :account_number - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -132,8 +132,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -162,14 +160,6 @@ def list_invalid_properties invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.') end - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') - end - - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') - end - invalid_properties end @@ -183,8 +173,6 @@ def valid? return false if @email.to_s.length < 1 return false if @name.nil? return false if @name.to_s.length < 1 - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 true end @@ -226,20 +214,6 @@ def name=(name) @name = name end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb b/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb index 69728bd..1b2f464 100644 --- a/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb +++ b/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb @@ -20,7 +20,7 @@ class W9FormRequest # The name of the business associated with the form. attr_accessor :business_name - # The classification of the business. + # 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) attr_accessor :business_classification # The classification description when \"businessClassification\" is \"Other\". @@ -56,7 +56,7 @@ class W9FormRequest # The account number associated with the form. attr_accessor :account_number - # The type of TIN provided. + # Tax Identification Number (TIN) type. SSN/ITIN (for individuals) and EIN (for businesses). attr_accessor :tin_type # The taxpayer identification number (TIN). @@ -74,7 +74,7 @@ class W9FormRequest # The signature of the form. attr_accessor :signature - # The ID of the associated company. + # The ID of the associated company. Required when creating a form. attr_accessor :company_id # A reference identifier for the form. @@ -217,6 +217,8 @@ def initialize(attributes = {}) if attributes.key?(:'name') self.name = attributes[:'name'] + else + self.name = nil end if attributes.key?(:'business_name') @@ -225,6 +227,8 @@ def initialize(attributes = {}) if attributes.key?(:'business_classification') self.business_classification = attributes[:'business_classification'] + else + self.business_classification = nil end if attributes.key?(:'business_other') @@ -249,6 +253,8 @@ def initialize(attributes = {}) if attributes.key?(:'address') self.address = attributes[:'address'] + else + self.address = nil end if attributes.key?(:'foreign_address') @@ -257,14 +263,20 @@ def initialize(attributes = {}) if attributes.key?(:'city') self.city = attributes[:'city'] + else + self.city = nil end if attributes.key?(:'state') self.state = attributes[:'state'] + else + self.state = nil end if attributes.key?(:'zip') self.zip = attributes[:'zip'] + else + self.zip = nil end if attributes.key?(:'account_number') @@ -273,10 +285,14 @@ def initialize(attributes = {}) if attributes.key?(:'tin_type') self.tin_type = attributes[:'tin_type'] + else + self.tin_type = nil end if attributes.key?(:'tin') self.tin = attributes[:'tin'] + else + self.tin = nil end if attributes.key?(:'backup_withholding') @@ -297,8 +313,6 @@ def initialize(attributes = {}) if attributes.key?(:'company_id') self.company_id = attributes[:'company_id'] - else - self.company_id = nil end if attributes.key?(:'reference_id') @@ -315,12 +329,24 @@ def initialize(attributes = {}) def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new - if @company_id.nil? - invalid_properties.push('invalid value for "company_id", company_id cannot be nil.') + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @business_classification.nil? + invalid_properties.push('invalid value for "business_classification", business_classification cannot be nil.') end - if @company_id.to_s.length < 1 - invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.') + if @address.nil? + invalid_properties.push('invalid value for "address", address cannot be nil.') + end + + if @tin_type.nil? + invalid_properties.push('invalid value for "tin_type", tin_type cannot be nil.') + end + + if @tin.nil? + invalid_properties.push('invalid value for "tin", tin cannot be nil.') end invalid_properties @@ -332,8 +358,11 @@ def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) return false unless type_validator.valid?(@type) - return false if @company_id.nil? - return false if @company_id.to_s.length < 1 + return false if @name.nil? + return false if @business_classification.nil? + return false if @address.nil? + return false if @tin_type.nil? + return false if @tin.nil? true end @@ -347,20 +376,6 @@ def type=(type) @type = type end - # Custom attribute writer method with validation - # @param [Object] company_id Value to be assigned - def company_id=(company_id) - if company_id.nil? - fail ArgumentError, 'company_id cannot be nil' - end - - if company_id.to_s.length < 1 - fail ArgumentError, 'invalid value for "company_id", the character length must be great than or equal to 1.' - end - - @company_id = company_id - end - # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb b/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb index 6ccf69e..da0a009 100644 --- a/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb +++ b/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb @@ -10,7 +10,10 @@ require 'time' module AvalaraSdk::A1099::V2 - class W9FormResponse < W9FormBaseResponse + class W9FormResponse + # The form type (always \"W9\" for this model). + attr_accessor :type + # The name of the individual or entity associated with the form. attr_accessor :name @@ -53,7 +56,7 @@ class W9FormResponse < W9FormBaseResponse # The account number associated with the form. attr_accessor :account_number - # The type of TIN provided. + # Tax Identification Number (TIN) type. attr_accessor :tin_type # The taxpayer identification number (TIN). @@ -68,9 +71,71 @@ class W9FormResponse < W9FormBaseResponse # The TIN Match status from IRS. attr_accessor :tin_match_status + # The unique identifier for the form. + attr_accessor :id + + # The entry status information for the form. + attr_accessor :entry_status + + # A reference identifier for the form. + attr_accessor :reference_id + + # The ID of the associated company. + attr_accessor :company_id + + # The display name associated with the form. + attr_accessor :display_name + + # The email address of the individual associated with the form. + attr_accessor :email + + # Indicates whether the form is archived. + attr_accessor :archived + + # Form ID of previous version. + attr_accessor :ancestor_id + + # The signature of the form. + attr_accessor :signature + + # The date the form was signed. + attr_accessor :signed_date + + # The date when e-delivery was consented. + attr_accessor :e_delivery_consented_at + + # The creation date of the form. + attr_accessor :created_at + + # The last updated date of the form. + attr_accessor :updated_at + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'name' => :'name', :'business_name' => :'businessName', :'business_classification' => :'businessClassification', @@ -89,18 +154,32 @@ def self.attribute_map :'tin' => :'tin', :'backup_withholding' => :'backupWithholding', :'is1099able' => :'is1099able', - :'tin_match_status' => :'tinMatchStatus' + :'tin_match_status' => :'tinMatchStatus', + :'id' => :'id', + :'entry_status' => :'entryStatus', + :'reference_id' => :'referenceId', + :'company_id' => :'companyId', + :'display_name' => :'displayName', + :'email' => :'email', + :'archived' => :'archived', + :'ancestor_id' => :'ancestorId', + :'signature' => :'signature', + :'signed_date' => :'signedDate', + :'e_delivery_consented_at' => :'eDeliveryConsentedAt', + :'created_at' => :'createdAt', + :'updated_at' => :'updatedAt' } end - # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + attribute_map.values end # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'name' => :'String', :'business_name' => :'String', :'business_classification' => :'String', @@ -119,7 +198,20 @@ def self.openapi_types :'tin' => :'String', :'backup_withholding' => :'Boolean', :'is1099able' => :'Boolean', - :'tin_match_status' => :'TinMatchStatusResponse' + :'tin_match_status' => :'TinMatchStatusResponse', + :'id' => :'String', + :'entry_status' => :'EntryStatusResponse', + :'reference_id' => :'String', + :'company_id' => :'String', + :'display_name' => :'String', + :'email' => :'String', + :'archived' => :'Boolean', + :'ancestor_id' => :'String', + :'signature' => :'String', + :'signed_date' => :'Time', + :'e_delivery_consented_at' => :'Time', + :'created_at' => :'Time', + :'updated_at' => :'Time' } end @@ -135,6 +227,12 @@ def self.openapi_nullable :'state', :'zip', :'account_number', + :'reference_id', + :'email', + :'ancestor_id', + :'signature', + :'signed_date', + :'e_delivery_consented_at', ]) end @@ -160,8 +258,9 @@ def initialize(attributes = {}) h[k.to_sym] = v } - # call parent's initialize - super(attributes) + if attributes.key?(:'type') + self.type = attributes[:'type'] + end if attributes.key?(:'name') self.name = attributes[:'name'] @@ -238,13 +337,65 @@ def initialize(attributes = {}) if attributes.key?(:'tin_match_status') self.tin_match_status = attributes[:'tin_match_status'] end + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'entry_status') + self.entry_status = attributes[:'entry_status'] + end + + if attributes.key?(:'reference_id') + self.reference_id = attributes[:'reference_id'] + end + + if attributes.key?(:'company_id') + self.company_id = attributes[:'company_id'] + end + + if attributes.key?(:'display_name') + self.display_name = attributes[:'display_name'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + end + + if attributes.key?(:'archived') + self.archived = attributes[:'archived'] + end + + if attributes.key?(:'ancestor_id') + self.ancestor_id = attributes[:'ancestor_id'] + end + + if attributes.key?(:'signature') + self.signature = attributes[:'signature'] + end + + if attributes.key?(:'signed_date') + self.signed_date = attributes[:'signed_date'] + end + + if attributes.key?(:'e_delivery_consented_at') + self.e_delivery_consented_at = attributes[:'e_delivery_consented_at'] + end + + if attributes.key?(:'created_at') + self.created_at = attributes[:'created_at'] + end + + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' - invalid_properties = super + invalid_properties = Array.new invalid_properties end @@ -252,7 +403,19 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - true && super + type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + return false unless type_validator.valid?(@type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type end # Checks equality by comparing each attribute. @@ -260,6 +423,7 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && name == o.name && business_name == o.business_name && business_classification == o.business_classification && @@ -278,7 +442,20 @@ def ==(o) tin == o.tin && backup_withholding == o.backup_withholding && is1099able == o.is1099able && - tin_match_status == o.tin_match_status && super(o) + tin_match_status == o.tin_match_status && + id == o.id && + entry_status == o.entry_status && + reference_id == o.reference_id && + company_id == o.company_id && + display_name == o.display_name && + email == o.email && + archived == o.archived && + ancestor_id == o.ancestor_id && + signature == o.signature && + signed_date == o.signed_date && + e_delivery_consented_at == o.e_delivery_consented_at && + created_at == o.created_at && + updated_at == o.updated_at end # @see the `==` method @@ -290,7 +467,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [name, business_name, business_classification, business_other, foreign_partner_owner_or_beneficiary, exempt_payee_code, exempt_fatca_code, foreign_country_indicator, address, foreign_address, city, state, zip, account_number, tin_type, tin, backup_withholding, is1099able, tin_match_status].hash + [type, name, business_name, business_classification, business_other, foreign_partner_owner_or_beneficiary, exempt_payee_code, exempt_fatca_code, foreign_country_indicator, address, foreign_address, city, state, zip, account_number, tin_type, tin, backup_withholding, is1099able, tin_match_status, id, entry_status, reference_id, company_id, display_name, email, archived, ancestor_id, signature, signed_date, e_delivery_consented_at, created_at, updated_at].hash end # Builds the object from hash @@ -298,7 +475,6 @@ def hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) - super(attributes) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| @@ -375,7 +551,7 @@ def to_body # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash - hash = super + hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? From af7e903f14d6b07eebfe207c09f3c2b2eea194b6 Mon Sep 17 00:00:00 2001 From: "svc.developer" Date: Fri, 19 Sep 2025 10:56:53 -0700 Subject: [PATCH 3/3] Fix gemlock --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 0126de8..60ae73b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - avalara_sdk (25.8.2) + avalara_sdk (25.8.3) faraday (~> 1.0, >= 1.0.1) GEM