avalara_sdk 26.9.0 → 26.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +17 -0
- data/docs/A1099/V2/BulkTinMatchAcceptedResponse.md +18 -0
- data/docs/A1099/V2/BulkTinMatchIrsResponse.md +20 -0
- data/docs/A1099/V2/BulkTinMatchRequest.md +18 -0
- data/docs/A1099/V2/BulkTinMatchRequestItem.md +24 -0
- data/docs/A1099/V2/BulkTinMatchResponse.md +26 -0
- data/docs/A1099/V2/BulkTinMatchResultItemResponse.md +22 -0
- data/docs/A1099/V2/CompaniesW9Api.md +5 -5
- data/docs/A1099/V2/Form1098.md +128 -0
- data/docs/A1099/V2/Form1098T.md +122 -0
- data/docs/A1099/V2/Form1099C.md +120 -0
- data/docs/A1099/V2/Form1099ListRequest.md +1 -1
- data/docs/A1099/V2/Form1099S.md +118 -0
- data/docs/A1099/V2/Form1099Sa.md +120 -0
- data/docs/A1099/V2/Forms1099Api.md +8 -8
- data/docs/A1099/V2/FormsW9Api.md +10 -10
- data/docs/A1099/V2/Get1099Form200Response.md +15 -0
- data/docs/A1099/V2/Issuers1099Api.md +89 -5
- data/docs/A1099/V2/JobsApi.md +1 -1
- data/docs/A1099/V2/PaginatedQueryResultModelBulkTinMatchResultItemResponse.md +22 -0
- data/docs/A1099/V2/ResubmitRejectedFormsResponse.md +18 -0
- data/docs/A1099/V2/TINMatchesApi.md +259 -1
- data/docs/EInvoicing/V1/CodeListVersion.md +2 -2
- data/docs/EInvoicing/V1/CodeListsApi.md +4 -4
- data/docs/EInvoicing/V1/ReportItem.md +2 -2
- data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +1011 -1011
- data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +1318 -1318
- data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +1581 -1581
- data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +1148 -1011
- data/lib/avalara_sdk/api/A1099/V2/jobs_api.rb +365 -365
- data/lib/avalara_sdk/api/A1099/V2/tin_matches_api.rb +868 -366
- data/lib/avalara_sdk/api/EInvoicing/V1/code_lists_api.rb +621 -621
- data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/reports_api.rb +718 -718
- data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +828 -828
- data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +530 -530
- data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/bulk_tin_match_accepted_response.rb +211 -0
- data/lib/avalara_sdk/models/A1099/V2/bulk_tin_match_irs_response.rb +219 -0
- data/lib/avalara_sdk/models/A1099/V2/bulk_tin_match_request.rb +213 -0
- data/lib/avalara_sdk/models/A1099/V2/bulk_tin_match_request_item.rb +275 -0
- data/lib/avalara_sdk/models/A1099/V2/bulk_tin_match_response.rb +246 -0
- data/lib/avalara_sdk/models/A1099/V2/bulk_tin_match_result_item_response.rb +229 -0
- data/lib/avalara_sdk/models/A1099/V2/company_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/company_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/covered_individual.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/create_and_send_w9_form_email_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/create_w9_form201_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/create_w9_form_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/entry_status_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/error_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/error_response_item.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/form1042_s.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1095_c.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1098.rb +887 -0
- data/lib/avalara_sdk/models/A1099/V2/form1098_t.rb +854 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1099_c.rb +863 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_div.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1099_int.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1099_list_request.rb +7 -7
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1099_patr.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/form1099_s.rb +836 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_sa.rb +859 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_status_detail.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/form1099_w2.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/get1099_form200_response.rb +14 -4
- data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/iris_form_base.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/irs_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/issuer_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/issuer_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/issuer_write_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/job_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/offer_and_coverage.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/paginated_query_result_model_bulk_tin_match_result_item_response.rb +234 -0
- data/lib/avalara_sdk/models/A1099/V2/paginated_query_result_model_company_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/paginated_query_result_model_form1099_base.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/paginated_query_result_model_issuer_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/paginated_query_result_model_w9_form_base_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/real_time_tin_match_irs_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/real_time_tin_match_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/real_time_tin_match_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/resubmit_rejected_forms_response.rb +211 -0
- data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/substantial_us_owner_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/substantial_us_owner_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/tin_match_status_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/validation_error.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/address.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/batch_error_detail.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/batch_search_participants202_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/code_list_list_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/code_list_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/code_list_summary.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/code_list_value.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/code_list_version.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/consents.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/create_trading_partner201_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/create_trading_partners_batch200_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/create_trading_partners_batch_request.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/event_id.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/event_message.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/event_payload.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/event_subscription.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/extension.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/hmac_signature.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/hmac_signature_value.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/id.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/identifier.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/output_data_formats.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/pagination.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/report_download_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/report_item.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/report_list_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/search_participants200_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/signature.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/signature_signature.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/signature_value.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/signature_value_signature.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/subscription_common.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/subscription_detail.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/subscription_list_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/subscription_registration.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/success_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/supported_document_statuses.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/supported_document_types.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/tax_identifier_request.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/tax_identifier_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/tax_identifier_response_value.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/update_trading_partner200_response.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/validation_error.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/webhook_invocation.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/webhooks_error_info.rb +4 -4
- data/lib/avalara_sdk/models/EInvoicing/V1/webhooks_error_response.rb +4 -4
- data/lib/avalara_sdk/version.rb +1 -1
- data/lib/avalara_sdk.rb +13 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +5 -5
- metadata +29 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 348500764da5b3d6a885bb8d8076b9c24e93b1a6879c5ac9b7c28addd615867c
|
|
4
|
+
data.tar.gz: e6c3837966e2aaa07e7f5052315f0a6bbafa245badd3dad3ea06201a8cfc2b63
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d37fe4a66a9c6045ea6cb233f6883800410b0aacc767ccde7eaea0a7a8b52f00939aa0410a46de6f0c31f8c47a9a283d4983013691260616291f2f1aa163ebf4
|
|
7
|
+
data.tar.gz: cc22630c182f6855a4ec350208931709c304544e761e7fe409187569885d183f7a0a0b5593441617426e94f74803a432859939286335d46f9492ab8e10c91a5d
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -108,9 +108,13 @@ Class | Method | HTTP request | Description
|
|
|
108
108
|
*Issuers1099Api* | [**delete_issuer**](docs/A1099/V2/Issuers1099Api.md#delete_issuer) | **DELETE** /1099/issuers/{id} | Delete an issuer
|
|
109
109
|
*Issuers1099Api* | [**get_issuer**](docs/A1099/V2/Issuers1099Api.md#get_issuer) | **GET** /1099/issuers/{id} | Retrieve an issuer
|
|
110
110
|
*Issuers1099Api* | [**get_issuers**](docs/A1099/V2/Issuers1099Api.md#get_issuers) | **GET** /1099/issuers | List issuers
|
|
111
|
+
*Issuers1099Api* | [**resubmit_rejected_forms**](docs/A1099/V2/Issuers1099Api.md#resubmit_rejected_forms) | **POST** /1099/issuers/{issuerId}/$resubmit-rejected-forms | Request a replacement submission for an issuer's rejected forms
|
|
111
112
|
*Issuers1099Api* | [**update_issuer**](docs/A1099/V2/Issuers1099Api.md#update_issuer) | **PUT** /1099/issuers/{id} | Update an issuer
|
|
112
113
|
*JobsApi* | [**get_job**](docs/A1099/V2/JobsApi.md#get_job) | **GET** /jobs/{id} | Retrieves information about the job
|
|
114
|
+
*TINMatchesApi* | [**get_bulk_tin_match**](docs/A1099/V2/TINMatchesApi.md#get_bulk_tin_match) | **GET** /tin-matches/$bulk/{id} | Get bulk TIN match details
|
|
115
|
+
*TINMatchesApi* | [**get_bulk_tin_match_results**](docs/A1099/V2/TINMatchesApi.md#get_bulk_tin_match_results) | **GET** /tin-matches/$bulk/{id}/results | List bulk TIN match results
|
|
113
116
|
*TINMatchesApi* | [**perform_real_time_tin_match**](docs/A1099/V2/TINMatchesApi.md#perform_real_time_tin_match) | **POST** /tin-matches/$real-time | Perform real time TIN Match
|
|
117
|
+
*TINMatchesApi* | [**submit_bulk_tin_match**](docs/A1099/V2/TINMatchesApi.md#submit_bulk_tin_match) | **POST** /tin-matches/$bulk | Submit bulk TIN match
|
|
114
118
|
|
|
115
119
|
<a name="documentation-for-models"></a>
|
|
116
120
|
## Documentation for Models
|
|
@@ -206,6 +210,12 @@ Class | Method | HTTP request | Description
|
|
|
206
210
|
<a name="documentation-for-A1099-V2-models"></a>
|
|
207
211
|
### A1099 V2 Model Documentation
|
|
208
212
|
|
|
213
|
+
- [models.BulkTinMatchAcceptedResponse](docs/A1099/V2/BulkTinMatchAcceptedResponse.md)
|
|
214
|
+
- [models.BulkTinMatchIrsResponse](docs/A1099/V2/BulkTinMatchIrsResponse.md)
|
|
215
|
+
- [models.BulkTinMatchRequest](docs/A1099/V2/BulkTinMatchRequest.md)
|
|
216
|
+
- [models.BulkTinMatchRequestItem](docs/A1099/V2/BulkTinMatchRequestItem.md)
|
|
217
|
+
- [models.BulkTinMatchResponse](docs/A1099/V2/BulkTinMatchResponse.md)
|
|
218
|
+
- [models.BulkTinMatchResultItemResponse](docs/A1099/V2/BulkTinMatchResultItemResponse.md)
|
|
209
219
|
- [models.CompanyRequest](docs/A1099/V2/CompanyRequest.md)
|
|
210
220
|
- [models.CompanyResponse](docs/A1099/V2/CompanyResponse.md)
|
|
211
221
|
- [models.CoveredIndividual](docs/A1099/V2/CoveredIndividual.md)
|
|
@@ -218,7 +228,10 @@ Class | Method | HTTP request | Description
|
|
|
218
228
|
- [models.Form1042S](docs/A1099/V2/Form1042S.md)
|
|
219
229
|
- [models.Form1095B](docs/A1099/V2/Form1095B.md)
|
|
220
230
|
- [models.Form1095C](docs/A1099/V2/Form1095C.md)
|
|
231
|
+
- [models.Form1098](docs/A1099/V2/Form1098.md)
|
|
232
|
+
- [models.Form1098T](docs/A1099/V2/Form1098T.md)
|
|
221
233
|
- [models.Form1099Base](docs/A1099/V2/Form1099Base.md)
|
|
234
|
+
- [models.Form1099C](docs/A1099/V2/Form1099C.md)
|
|
222
235
|
- [models.Form1099Div](docs/A1099/V2/Form1099Div.md)
|
|
223
236
|
- [models.Form1099Int](docs/A1099/V2/Form1099Int.md)
|
|
224
237
|
- [models.Form1099K](docs/A1099/V2/Form1099K.md)
|
|
@@ -227,6 +240,8 @@ Class | Method | HTTP request | Description
|
|
|
227
240
|
- [models.Form1099Nec](docs/A1099/V2/Form1099Nec.md)
|
|
228
241
|
- [models.Form1099Patr](docs/A1099/V2/Form1099Patr.md)
|
|
229
242
|
- [models.Form1099R](docs/A1099/V2/Form1099R.md)
|
|
243
|
+
- [models.Form1099S](docs/A1099/V2/Form1099S.md)
|
|
244
|
+
- [models.Form1099Sa](docs/A1099/V2/Form1099Sa.md)
|
|
230
245
|
- [models.Form1099StatusDetail](docs/A1099/V2/Form1099StatusDetail.md)
|
|
231
246
|
- [models.Form1099W2](docs/A1099/V2/Form1099W2.md)
|
|
232
247
|
- [models.Get1099Form200Response](docs/A1099/V2/Get1099Form200Response.md)
|
|
@@ -238,6 +253,7 @@ Class | Method | HTTP request | Description
|
|
|
238
253
|
- [models.IssuerWriteResponse](docs/A1099/V2/IssuerWriteResponse.md)
|
|
239
254
|
- [models.JobResponse](docs/A1099/V2/JobResponse.md)
|
|
240
255
|
- [models.OfferAndCoverage](docs/A1099/V2/OfferAndCoverage.md)
|
|
256
|
+
- [models.PaginatedQueryResultModelBulkTinMatchResultItemResponse](docs/A1099/V2/PaginatedQueryResultModelBulkTinMatchResultItemResponse.md)
|
|
241
257
|
- [models.PaginatedQueryResultModelCompanyResponse](docs/A1099/V2/PaginatedQueryResultModelCompanyResponse.md)
|
|
242
258
|
- [models.PaginatedQueryResultModelForm1099Base](docs/A1099/V2/PaginatedQueryResultModelForm1099Base.md)
|
|
243
259
|
- [models.PaginatedQueryResultModelIssuerResponse](docs/A1099/V2/PaginatedQueryResultModelIssuerResponse.md)
|
|
@@ -246,6 +262,7 @@ Class | Method | HTTP request | Description
|
|
|
246
262
|
- [models.RealTimeTinMatchIrsResponse](docs/A1099/V2/RealTimeTinMatchIrsResponse.md)
|
|
247
263
|
- [models.RealTimeTinMatchRequest](docs/A1099/V2/RealTimeTinMatchRequest.md)
|
|
248
264
|
- [models.RealTimeTinMatchResponse](docs/A1099/V2/RealTimeTinMatchResponse.md)
|
|
265
|
+
- [models.ResubmitRejectedFormsResponse](docs/A1099/V2/ResubmitRejectedFormsResponse.md)
|
|
249
266
|
- [models.StateAndLocalWithholding](docs/A1099/V2/StateAndLocalWithholding.md)
|
|
250
267
|
- [models.StateEfileStatusDetail](docs/A1099/V2/StateEfileStatusDetail.md)
|
|
251
268
|
- [models.SubstantialUsOwnerRequest](docs/A1099/V2/SubstantialUsOwnerRequest.md)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# AvalaraSdk::A1099::V2::BulkTinMatchAcceptedResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The bulk identifier required to get the results. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'avalara_sdk'
|
|
13
|
+
|
|
14
|
+
instance = AvalaraSdk::A1099::V2::BulkTinMatchAcceptedResponse.new(
|
|
15
|
+
id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AvalaraSdk::A1099::V2::BulkTinMatchIrsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | | [optional] |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'avalara_sdk'
|
|
14
|
+
|
|
15
|
+
instance = AvalaraSdk::A1099::V2::BulkTinMatchIrsResponse.new(
|
|
16
|
+
code: null,
|
|
17
|
+
description: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# AvalaraSdk::A1099::V2::BulkTinMatchRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **items** | [**Array<BulkTinMatchRequestItem>**](BulkTinMatchRequestItem.md) | Collection of TINs to be submitted to TIN match. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'avalara_sdk'
|
|
13
|
+
|
|
14
|
+
instance = AvalaraSdk::A1099::V2::BulkTinMatchRequest.new(
|
|
15
|
+
items: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AvalaraSdk::A1099::V2::BulkTinMatchRequestItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **tin_type** | **String** | The TIN type. | [optional] |
|
|
8
|
+
| **tin** | **String** | The TIN to be submitted to TIN match. | [optional] |
|
|
9
|
+
| **name** | **String** | The entity name to be submitted to TIN match. | [optional] |
|
|
10
|
+
| **reference_id** | **String** | The reference identifier for the TIN to be submitted. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'avalara_sdk'
|
|
16
|
+
|
|
17
|
+
instance = AvalaraSdk::A1099::V2::BulkTinMatchRequestItem.new(
|
|
18
|
+
tin_type: null,
|
|
19
|
+
tin: null,
|
|
20
|
+
name: null,
|
|
21
|
+
reference_id: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# AvalaraSdk::A1099::V2::BulkTinMatchResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **status** | **String** | | [optional] |
|
|
9
|
+
| **created_at** | **Time** | | [optional] |
|
|
10
|
+
| **updated_at** | **Time** | | [optional] |
|
|
11
|
+
| **results_url** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'avalara_sdk'
|
|
17
|
+
|
|
18
|
+
instance = AvalaraSdk::A1099::V2::BulkTinMatchResponse.new(
|
|
19
|
+
id: null,
|
|
20
|
+
status: null,
|
|
21
|
+
created_at: null,
|
|
22
|
+
updated_at: null,
|
|
23
|
+
results_url: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AvalaraSdk::A1099::V2::BulkTinMatchResultItemResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | [optional] |
|
|
8
|
+
| **irs_response** | [**BulkTinMatchIrsResponse**](BulkTinMatchIrsResponse.md) | | [optional] |
|
|
9
|
+
| **reference_id** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'avalara_sdk'
|
|
15
|
+
|
|
16
|
+
instance = AvalaraSdk::A1099::V2::BulkTinMatchResultItemResponse.new(
|
|
17
|
+
status: null,
|
|
18
|
+
irs_response: null,
|
|
19
|
+
reference_id: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -39,7 +39,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
|
|
|
39
39
|
|
|
40
40
|
avalara_version = '2.0.0' # String | API version
|
|
41
41
|
opts = {
|
|
42
|
-
x_correlation_id: '
|
|
42
|
+
x_correlation_id: '6178f38d-9576-40f3-9d81-81923b745635', # String | Unique correlation Id in a GUID format
|
|
43
43
|
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/) .
|
|
44
44
|
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
|
|
45
45
|
}
|
|
@@ -123,7 +123,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
|
|
|
123
123
|
id = 'id_example' # String | The company to delete
|
|
124
124
|
avalara_version = '2.0.0' # String | API version
|
|
125
125
|
opts = {
|
|
126
|
-
x_correlation_id: '
|
|
126
|
+
x_correlation_id: '319f54f2-5b38-4c4f-909b-12fb99a51b62', # String | Unique correlation Id in a GUID format
|
|
127
127
|
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/) .
|
|
128
128
|
}
|
|
129
129
|
|
|
@@ -210,7 +210,7 @@ opts = {
|
|
|
210
210
|
order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
|
|
211
211
|
count: true, # Boolean | If true, return the global count of elements in the collection.
|
|
212
212
|
count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
|
|
213
|
-
x_correlation_id: '
|
|
213
|
+
x_correlation_id: 'ddaab1c5-a4e7-44d0-992a-8d2477ae1709', # String | Unique correlation Id in a GUID format
|
|
214
214
|
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/) .
|
|
215
215
|
}
|
|
216
216
|
|
|
@@ -298,7 +298,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
|
|
|
298
298
|
id = 'id_example' # String | Id of the company
|
|
299
299
|
avalara_version = '2.0.0' # String | API version
|
|
300
300
|
opts = {
|
|
301
|
-
x_correlation_id: '
|
|
301
|
+
x_correlation_id: '79462281-b63b-40e6-bac7-e9e975607cde', # String | Unique correlation Id in a GUID format
|
|
302
302
|
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/) .
|
|
303
303
|
}
|
|
304
304
|
|
|
@@ -381,7 +381,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
|
|
|
381
381
|
id = 'id_example' # String | The ID of the company to update
|
|
382
382
|
avalara_version = '2.0.0' # String | API version
|
|
383
383
|
opts = {
|
|
384
|
-
x_correlation_id: '
|
|
384
|
+
x_correlation_id: 'a04b27f3-eb0f-4ec0-943c-d0902b668fa5', # String | Unique correlation Id in a GUID format
|
|
385
385
|
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/) .
|
|
386
386
|
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
|
|
387
387
|
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# AvalaraSdk::A1099::V2::Form1098
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mortgage_interest_received** | **Float** | Mortgage interest received from payer(s)/borrower(s) | [optional] |
|
|
8
|
+
| **outstanding_mortgage_principal** | **Float** | Outstanding mortgage principal | [optional] |
|
|
9
|
+
| **mortgage_origination_date** | **Date** | Mortgage origination date | [optional] |
|
|
10
|
+
| **refund_of_overpaid_interest** | **Float** | Refund of overpaid interest | [optional] |
|
|
11
|
+
| **mortgage_insurance_premiums** | **Float** | Mortgage insurance premiums | [optional] |
|
|
12
|
+
| **points_paid_on_purchase_of_principal_residence** | **Float** | Points paid on purchase of principal residence | [optional] |
|
|
13
|
+
| **property_address_same_as_borrower_indicator** | **Boolean** | If checked, the property securing the mortgage is at the borrower's address | [optional] |
|
|
14
|
+
| **property_address_or_description** | **String** | Address or description of property securing mortgage (up to 39 characters) | [optional] |
|
|
15
|
+
| **number_of_properties_securing_mortgage** | **Integer** | Number of properties securing the mortgage, if more than one | [optional] |
|
|
16
|
+
| **other_information** | **String** | Other (up to 39 characters), such as real estate taxes or insurance paid from escrow | [optional] |
|
|
17
|
+
| **mortgage_acquisition_date** | **Date** | Mortgage acquisition date, if the mortgage was acquired during the tax year | [optional] |
|
|
18
|
+
| **type** | **String** | Form type. | |
|
|
19
|
+
| **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] |
|
|
20
|
+
| **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] |
|
|
21
|
+
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] |
|
|
22
|
+
| **issuer_tin** | **String** | Issuer TIN - readonly | [optional] |
|
|
23
|
+
| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] |
|
|
24
|
+
| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] |
|
|
25
|
+
| **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] |
|
|
26
|
+
| **recipient_name** | **String** | DEPRECATED: Use `businessName` for businesses; use `firstName`, `middleName`, `lastName`, and `suffixName` for individuals. | [optional] |
|
|
27
|
+
| **address** | **String** | Address. | |
|
|
28
|
+
| **address2** | **String** | Address line 2. | [optional] |
|
|
29
|
+
| **city** | **String** | City. | |
|
|
30
|
+
| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional] |
|
|
31
|
+
| **zip** | **String** | ZIP/postal code. | [optional] |
|
|
32
|
+
| **email** | **String** | Recipient's Contact email address. | [optional] |
|
|
33
|
+
| **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
|
34
|
+
| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | |
|
|
35
|
+
| **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] |
|
|
36
|
+
| **postal_mail** | **Boolean** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] |
|
|
37
|
+
| **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] |
|
|
38
|
+
| **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] |
|
|
39
|
+
| **tin_match** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] |
|
|
40
|
+
| **address_verification** | **Boolean** | Boolean indicating that address verification should be scheduled for this form | [optional] |
|
|
41
|
+
| **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] |
|
|
42
|
+
| **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] |
|
|
43
|
+
| **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] |
|
|
44
|
+
| **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] |
|
|
45
|
+
| **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] |
|
|
46
|
+
| **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] |
|
|
47
|
+
| **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] |
|
|
48
|
+
| **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] |
|
|
49
|
+
| **created_at** | **Time** | Date time when the record was created. | [optional][readonly] |
|
|
50
|
+
| **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] |
|
|
51
|
+
| **tin_type** | **String** | Recipient classification. The platform is transitioning from tax identifier classifications to recipient entity classifications. New values represent recipient entity types and should be preferred. Deprecated values represent identifier formats and remain supported for backward compatibility only. Available values: - INDIVIDUAL: Recipient is an individual - BUSINESS: Recipient is a business - UNKNOWN: Recipient classification is unknown - EIN: (Deprecated - use BUSINESS) Employer Identification Number - SSN: (Deprecated - use INDIVIDUAL) Social Security Number - ITIN: (Deprecated - use INDIVIDUAL) Individual Taxpayer Identification Number - ATIN: (Deprecated - use INDIVIDUAL) Adoption Taxpayer Identification Number | [optional] |
|
|
52
|
+
| **business_name** | **String** | Business name. Required when the recipient of the form is a business; should only be used for businesses. | [optional] |
|
|
53
|
+
| **business_name2** | **String** | Business name line 2. Should only be used for businesses. | [optional] |
|
|
54
|
+
| **first_name** | **String** | First name. Required when the recipient of the form is an individual; should only be used for individuals. | [optional] |
|
|
55
|
+
| **middle_name** | **String** | Middle name. Should only be used for individuals. | [optional] |
|
|
56
|
+
| **last_name** | **String** | Last name. Required when the recipient of the form is an individual; should only be used for individuals. | [optional] |
|
|
57
|
+
| **suffix_name** | **String** | Suffix name. Should only be used for individuals. | [optional] |
|
|
58
|
+
| **recipient_second_name** | **String** | DEPRECATED: Use `businessName2` instead. | [optional] |
|
|
59
|
+
| **account_number** | **String** | Account number | [optional] |
|
|
60
|
+
| **office_code** | **String** | Office code | [optional] |
|
|
61
|
+
| **no_tin** | **Boolean** | No TIN indicator | [optional] |
|
|
62
|
+
| **second_tin_notice** | **Boolean** | Second TIN notice | [optional] |
|
|
63
|
+
|
|
64
|
+
## Example
|
|
65
|
+
|
|
66
|
+
```ruby
|
|
67
|
+
require 'avalara_sdk'
|
|
68
|
+
|
|
69
|
+
instance = AvalaraSdk::A1099::V2::Form1098.new(
|
|
70
|
+
mortgage_interest_received: null,
|
|
71
|
+
outstanding_mortgage_principal: null,
|
|
72
|
+
mortgage_origination_date: null,
|
|
73
|
+
refund_of_overpaid_interest: null,
|
|
74
|
+
mortgage_insurance_premiums: null,
|
|
75
|
+
points_paid_on_purchase_of_principal_residence: null,
|
|
76
|
+
property_address_same_as_borrower_indicator: null,
|
|
77
|
+
property_address_or_description: null,
|
|
78
|
+
number_of_properties_securing_mortgage: null,
|
|
79
|
+
other_information: null,
|
|
80
|
+
mortgage_acquisition_date: null,
|
|
81
|
+
type: null,
|
|
82
|
+
id: null,
|
|
83
|
+
issuer_id: null,
|
|
84
|
+
issuer_reference_id: null,
|
|
85
|
+
issuer_tin: null,
|
|
86
|
+
tax_year: null,
|
|
87
|
+
reference_id: null,
|
|
88
|
+
tin: null,
|
|
89
|
+
recipient_name: null,
|
|
90
|
+
address: null,
|
|
91
|
+
address2: null,
|
|
92
|
+
city: null,
|
|
93
|
+
state: null,
|
|
94
|
+
zip: null,
|
|
95
|
+
email: null,
|
|
96
|
+
non_us_province: null,
|
|
97
|
+
country_code: null,
|
|
98
|
+
federal_efile_date: null,
|
|
99
|
+
postal_mail: null,
|
|
100
|
+
state_efile_date: null,
|
|
101
|
+
recipient_edelivery_date: null,
|
|
102
|
+
tin_match: null,
|
|
103
|
+
address_verification: null,
|
|
104
|
+
state_and_local_withholding: null,
|
|
105
|
+
federal_efile_status: null,
|
|
106
|
+
state_efile_status: null,
|
|
107
|
+
postal_mail_status: null,
|
|
108
|
+
tin_match_status: null,
|
|
109
|
+
address_verification_status: null,
|
|
110
|
+
e_delivery_status: null,
|
|
111
|
+
validation_errors: null,
|
|
112
|
+
created_at: null,
|
|
113
|
+
updated_at: null,
|
|
114
|
+
tin_type: null,
|
|
115
|
+
business_name: null,
|
|
116
|
+
business_name2: null,
|
|
117
|
+
first_name: null,
|
|
118
|
+
middle_name: null,
|
|
119
|
+
last_name: null,
|
|
120
|
+
suffix_name: null,
|
|
121
|
+
recipient_second_name: null,
|
|
122
|
+
account_number: null,
|
|
123
|
+
office_code: null,
|
|
124
|
+
no_tin: null,
|
|
125
|
+
second_tin_notice: null
|
|
126
|
+
)
|
|
127
|
+
```
|
|
128
|
+
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# AvalaraSdk::A1099::V2::Form1098T
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payments_received_for_qualified_tuition_and_related_expenses** | **Float** | Payments received for qualified tuition and related expenses | [optional] |
|
|
8
|
+
| **adjustments_made_for_prior_year** | **Float** | Adjustments made for a prior year | [optional] |
|
|
9
|
+
| **scholarships_or_grants** | **Float** | Scholarships or grants | [optional] |
|
|
10
|
+
| **adjustments_to_scholarships_or_grants_for_prior_year** | **Float** | Adjustments to scholarships or grants for a prior year | [optional] |
|
|
11
|
+
| **includes_amounts_for_academic_period_beginning_next_year_indicator** | **Boolean** | If checked, the amount in Box 1 includes amounts for an academic period beginning January through March of the next year | [optional] |
|
|
12
|
+
| **at_least_half_time_student_indicator** | **Boolean** | If checked, the student was at least a half-time student during any academic period that began in the tax year | [optional] |
|
|
13
|
+
| **graduate_student_indicator** | **Boolean** | If checked, the student was enrolled in a program leading to a graduate degree, certificate or credential | [optional] |
|
|
14
|
+
| **insurance_contract_reimbursements_or_refunds** | **Float** | Insurance contract reimbursements or refunds (insurers only) | [optional] |
|
|
15
|
+
| **type** | **String** | Form type. | |
|
|
16
|
+
| **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] |
|
|
17
|
+
| **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] |
|
|
18
|
+
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] |
|
|
19
|
+
| **issuer_tin** | **String** | Issuer TIN - readonly | [optional] |
|
|
20
|
+
| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] |
|
|
21
|
+
| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] |
|
|
22
|
+
| **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] |
|
|
23
|
+
| **recipient_name** | **String** | DEPRECATED: Use `businessName` for businesses; use `firstName`, `middleName`, `lastName`, and `suffixName` for individuals. | [optional] |
|
|
24
|
+
| **address** | **String** | Address. | |
|
|
25
|
+
| **address2** | **String** | Address line 2. | [optional] |
|
|
26
|
+
| **city** | **String** | City. | |
|
|
27
|
+
| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional] |
|
|
28
|
+
| **zip** | **String** | ZIP/postal code. | [optional] |
|
|
29
|
+
| **email** | **String** | Recipient's Contact email address. | [optional] |
|
|
30
|
+
| **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
|
31
|
+
| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | |
|
|
32
|
+
| **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] |
|
|
33
|
+
| **postal_mail** | **Boolean** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] |
|
|
34
|
+
| **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] |
|
|
35
|
+
| **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] |
|
|
36
|
+
| **tin_match** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] |
|
|
37
|
+
| **address_verification** | **Boolean** | Boolean indicating that address verification should be scheduled for this form | [optional] |
|
|
38
|
+
| **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] |
|
|
39
|
+
| **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] |
|
|
40
|
+
| **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] |
|
|
41
|
+
| **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] |
|
|
42
|
+
| **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] |
|
|
43
|
+
| **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] |
|
|
44
|
+
| **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] |
|
|
45
|
+
| **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] |
|
|
46
|
+
| **created_at** | **Time** | Date time when the record was created. | [optional][readonly] |
|
|
47
|
+
| **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] |
|
|
48
|
+
| **tin_type** | **String** | Recipient classification. The platform is transitioning from tax identifier classifications to recipient entity classifications. New values represent recipient entity types and should be preferred. Deprecated values represent identifier formats and remain supported for backward compatibility only. Available values: - INDIVIDUAL: Recipient is an individual - BUSINESS: Recipient is a business - UNKNOWN: Recipient classification is unknown - EIN: (Deprecated - use BUSINESS) Employer Identification Number - SSN: (Deprecated - use INDIVIDUAL) Social Security Number - ITIN: (Deprecated - use INDIVIDUAL) Individual Taxpayer Identification Number - ATIN: (Deprecated - use INDIVIDUAL) Adoption Taxpayer Identification Number | [optional] |
|
|
49
|
+
| **business_name** | **String** | Business name. Required when the recipient of the form is a business; should only be used for businesses. | [optional] |
|
|
50
|
+
| **business_name2** | **String** | Business name line 2. Should only be used for businesses. | [optional] |
|
|
51
|
+
| **first_name** | **String** | First name. Required when the recipient of the form is an individual; should only be used for individuals. | [optional] |
|
|
52
|
+
| **middle_name** | **String** | Middle name. Should only be used for individuals. | [optional] |
|
|
53
|
+
| **last_name** | **String** | Last name. Required when the recipient of the form is an individual; should only be used for individuals. | [optional] |
|
|
54
|
+
| **suffix_name** | **String** | Suffix name. Should only be used for individuals. | [optional] |
|
|
55
|
+
| **recipient_second_name** | **String** | DEPRECATED: Use `businessName2` instead. | [optional] |
|
|
56
|
+
| **account_number** | **String** | Account number | [optional] |
|
|
57
|
+
| **office_code** | **String** | Office code | [optional] |
|
|
58
|
+
| **no_tin** | **Boolean** | No TIN indicator | [optional] |
|
|
59
|
+
| **second_tin_notice** | **Boolean** | Second TIN notice | [optional] |
|
|
60
|
+
|
|
61
|
+
## Example
|
|
62
|
+
|
|
63
|
+
```ruby
|
|
64
|
+
require 'avalara_sdk'
|
|
65
|
+
|
|
66
|
+
instance = AvalaraSdk::A1099::V2::Form1098T.new(
|
|
67
|
+
payments_received_for_qualified_tuition_and_related_expenses: null,
|
|
68
|
+
adjustments_made_for_prior_year: null,
|
|
69
|
+
scholarships_or_grants: null,
|
|
70
|
+
adjustments_to_scholarships_or_grants_for_prior_year: null,
|
|
71
|
+
includes_amounts_for_academic_period_beginning_next_year_indicator: null,
|
|
72
|
+
at_least_half_time_student_indicator: null,
|
|
73
|
+
graduate_student_indicator: null,
|
|
74
|
+
insurance_contract_reimbursements_or_refunds: null,
|
|
75
|
+
type: null,
|
|
76
|
+
id: null,
|
|
77
|
+
issuer_id: null,
|
|
78
|
+
issuer_reference_id: null,
|
|
79
|
+
issuer_tin: null,
|
|
80
|
+
tax_year: null,
|
|
81
|
+
reference_id: null,
|
|
82
|
+
tin: null,
|
|
83
|
+
recipient_name: null,
|
|
84
|
+
address: null,
|
|
85
|
+
address2: null,
|
|
86
|
+
city: null,
|
|
87
|
+
state: null,
|
|
88
|
+
zip: null,
|
|
89
|
+
email: null,
|
|
90
|
+
non_us_province: null,
|
|
91
|
+
country_code: null,
|
|
92
|
+
federal_efile_date: null,
|
|
93
|
+
postal_mail: null,
|
|
94
|
+
state_efile_date: null,
|
|
95
|
+
recipient_edelivery_date: null,
|
|
96
|
+
tin_match: null,
|
|
97
|
+
address_verification: null,
|
|
98
|
+
state_and_local_withholding: null,
|
|
99
|
+
federal_efile_status: null,
|
|
100
|
+
state_efile_status: null,
|
|
101
|
+
postal_mail_status: null,
|
|
102
|
+
tin_match_status: null,
|
|
103
|
+
address_verification_status: null,
|
|
104
|
+
e_delivery_status: null,
|
|
105
|
+
validation_errors: null,
|
|
106
|
+
created_at: null,
|
|
107
|
+
updated_at: null,
|
|
108
|
+
tin_type: null,
|
|
109
|
+
business_name: null,
|
|
110
|
+
business_name2: null,
|
|
111
|
+
first_name: null,
|
|
112
|
+
middle_name: null,
|
|
113
|
+
last_name: null,
|
|
114
|
+
suffix_name: null,
|
|
115
|
+
recipient_second_name: null,
|
|
116
|
+
account_number: null,
|
|
117
|
+
office_code: null,
|
|
118
|
+
no_tin: null,
|
|
119
|
+
second_tin_notice: null
|
|
120
|
+
)
|
|
121
|
+
```
|
|
122
|
+
|