avalara_sdk 25.8.3 → 25.9.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 +4 -14
- data/docs/A1099/V2/CompaniesW9Api.md +9 -9
- data/docs/A1099/V2/CompanyBase.md +50 -0
- data/docs/A1099/V2/CompanyRequest.md +50 -0
- data/docs/A1099/V2/Form1042S.md +16 -16
- data/docs/A1099/V2/Form1095B.md +15 -15
- data/docs/A1099/V2/Form1095C.md +14 -14
- data/docs/A1099/V2/Form1099Base.md +14 -14
- data/docs/A1099/V2/Form1099Div.md +15 -15
- data/docs/A1099/V2/Form1099Int.md +16 -16
- data/docs/A1099/V2/Form1099K.md +20 -20
- data/docs/A1099/V2/Form1099ListRequest.md +1 -1
- data/docs/A1099/V2/Form1099Misc.md +15 -15
- data/docs/A1099/V2/Form1099Nec.md +17 -17
- data/docs/A1099/V2/Form1099R.md +17 -17
- data/docs/A1099/V2/Forms1099Api.md +12 -12
- data/docs/A1099/V2/FormsW9Api.md +17 -17
- data/docs/A1099/V2/IntermediaryOrFlowThrough.md +2 -2
- data/docs/A1099/V2/IssuerBase.md +46 -0
- data/docs/A1099/V2/IssuerRequest.md +46 -0
- data/docs/A1099/V2/Issuers1099Api.md +9 -9
- data/docs/A1099/V2/JobResponse.md +1 -1
- data/docs/A1099/V2/JobsApi.md +1 -1
- data/docs/A1099/V2/TinMatchStatusResponse.md +1 -1
- data/docs/A1099/V2/W4FormMinimalRequest.md +2 -2
- data/docs/A1099/V2/W4FormRequest.md +11 -11
- data/docs/A1099/V2/W4FormResponse.md +48 -20
- data/docs/A1099/V2/W8BenEFormMinimalRequest.md +2 -2
- data/docs/A1099/V2/W8BenEFormRequest.md +10 -10
- data/docs/A1099/V2/W8BenEFormResponse.md +96 -68
- data/docs/A1099/V2/W8BenFormMinimalRequest.md +2 -2
- data/docs/A1099/V2/W8BenFormRequest.md +6 -6
- data/docs/A1099/V2/W8BenFormResponse.md +55 -27
- data/docs/A1099/V2/W8ImyFormMinimalRequest.md +2 -2
- data/docs/A1099/V2/W8ImyFormRequest.md +10 -10
- data/docs/A1099/V2/W8ImyFormResponse.md +118 -90
- data/docs/A1099/V2/W9FormBaseMinimalRequest.md +2 -2
- data/docs/A1099/V2/W9FormBaseRequest.md +2 -2
- data/docs/A1099/V2/W9FormBaseResponse.md +3 -3
- data/docs/A1099/V2/W9FormMinimalRequest.md +2 -2
- data/docs/A1099/V2/W9FormRequest.md +10 -10
- data/docs/A1099/V2/W9FormResponse.md +44 -16
- data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +21 -21
- data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +7 -7
- data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +16 -16
- data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +21 -21
- data/lib/avalara_sdk/api/A1099/V2/jobs_api.rb +1 -1
- 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/subscriptions_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +1 -1
- data/lib/avalara_sdk/api_client.rb +10 -2
- data/lib/avalara_sdk/models/A1099/V2/company_base.rb +404 -0
- data/lib/avalara_sdk/models/A1099/V2/company_request.rb +411 -0
- data/lib/avalara_sdk/models/A1099/V2/company_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/error_response.rb +0 -6
- data/lib/avalara_sdk/models/A1099/V2/form1042_s.rb +20 -30
- data/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +19 -40
- data/lib/avalara_sdk/models/A1099/V2/form1095_c.rb +18 -49
- data/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +18 -29
- data/lib/avalara_sdk/models/A1099/V2/form1099_div.rb +20 -31
- data/lib/avalara_sdk/models/A1099/V2/form1099_int.rb +22 -32
- data/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +35 -38
- data/lib/avalara_sdk/models/A1099/V2/form1099_list_request.rb +2 -12
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +20 -31
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +23 -33
- data/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +48 -33
- data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb +48 -2
- data/lib/avalara_sdk/models/A1099/V2/issuer_base.rb +384 -0
- data/lib/avalara_sdk/models/A1099/V2/issuer_request.rb +391 -0
- data/lib/avalara_sdk/models/A1099/V2/issuer_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/job_response.rb +0 -6
- data/lib/avalara_sdk/models/A1099/V2/validation_error.rb +0 -6
- data/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb +1 -27
- data/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb +31 -29
- data/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb +191 -15
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb +1 -27
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +37 -28
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb +190 -14
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb +1 -27
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +20 -23
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb +191 -15
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb +1 -27
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb +30 -28
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb +191 -15
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb +1 -27
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb +1 -27
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb +47 -18
- data/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb +1 -27
- data/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb +40 -25
- data/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb +190 -14
- data/lib/avalara_sdk/version.rb +1 -1
- data/lib/avalara_sdk.rb +8 -4
- 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 +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 309acaa143a21239e5db6a610bd6c0f2c9b4f88feafaddf50bd13deddec9430f
|
4
|
+
data.tar.gz: c0c55dda56af6026759209d2a4896ac8ad9c94dd9f8956b882e3e28dc32fb055
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a6cf69d9884ea70b6e2acb192798740ee196c4f37b35e31e52b33680623d8e49c4ef77e746c2c8116511085f1e630a4c6111344e2da11cb923cca4547e09a7d5
|
7
|
+
data.tar.gz: e6b7762f9d01b9c374dfe62861490695bfccc5f5ce2eaf18e4fcc2c3023a4e00d662b06aa3240650c501ba772f9099b8c30141f7fc69fe0adc0bd53a9a8f9e0d
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -190,18 +190,14 @@ Class | Method | HTTP request | Description
|
|
190
190
|
<a name="documentation-for-A1099-V2-models"></a>
|
191
191
|
### A1099 V2 Model Documentation
|
192
192
|
|
193
|
-
- [models.
|
194
|
-
- [models.
|
195
|
-
- [models.CompanyCreateUpdateRequestModel](docs/A1099/V2/CompanyCreateUpdateRequestModel.md)
|
193
|
+
- [models.CompanyBase](docs/A1099/V2/CompanyBase.md)
|
194
|
+
- [models.CompanyRequest](docs/A1099/V2/CompanyRequest.md)
|
196
195
|
- [models.CompanyResponse](docs/A1099/V2/CompanyResponse.md)
|
197
196
|
- [models.CoveredIndividual](docs/A1099/V2/CoveredIndividual.md)
|
198
197
|
- [models.CreateAndSendW9FormEmailRequest](docs/A1099/V2/CreateAndSendW9FormEmailRequest.md)
|
199
|
-
- [models.CreateCompanyRequest](docs/A1099/V2/CreateCompanyRequest.md)
|
200
|
-
- [models.CreateIssuerRequest](docs/A1099/V2/CreateIssuerRequest.md)
|
201
198
|
- [models.CreateW9Form201Response](docs/A1099/V2/CreateW9Form201Response.md)
|
202
199
|
- [models.CreateW9FormRequest](docs/A1099/V2/CreateW9FormRequest.md)
|
203
200
|
- [models.EntryStatusResponse](docs/A1099/V2/EntryStatusResponse.md)
|
204
|
-
- [models.ErrorModel](docs/A1099/V2/ErrorModel.md)
|
205
201
|
- [models.ErrorResponse](docs/A1099/V2/ErrorResponse.md)
|
206
202
|
- [models.ErrorResponseItem](docs/A1099/V2/ErrorResponseItem.md)
|
207
203
|
- [models.Form1042S](docs/A1099/V2/Form1042S.md)
|
@@ -217,10 +213,10 @@ Class | Method | HTTP request | Description
|
|
217
213
|
- [models.Form1099R](docs/A1099/V2/Form1099R.md)
|
218
214
|
- [models.Form1099StatusDetail](docs/A1099/V2/Form1099StatusDetail.md)
|
219
215
|
- [models.Get1099Form200Response](docs/A1099/V2/Get1099Form200Response.md)
|
220
|
-
- [models.IW9FormDataModelsOneOf](docs/A1099/V2/IW9FormDataModelsOneOf.md)
|
221
216
|
- [models.IntermediaryOrFlowThrough](docs/A1099/V2/IntermediaryOrFlowThrough.md)
|
222
217
|
- [models.IrsResponse](docs/A1099/V2/IrsResponse.md)
|
223
|
-
- [models.
|
218
|
+
- [models.IssuerBase](docs/A1099/V2/IssuerBase.md)
|
219
|
+
- [models.IssuerRequest](docs/A1099/V2/IssuerRequest.md)
|
224
220
|
- [models.IssuerResponse](docs/A1099/V2/IssuerResponse.md)
|
225
221
|
- [models.JobResponse](docs/A1099/V2/JobResponse.md)
|
226
222
|
- [models.OfferAndCoverage](docs/A1099/V2/OfferAndCoverage.md)
|
@@ -235,27 +231,21 @@ Class | Method | HTTP request | Description
|
|
235
231
|
- [models.SubstantialUsOwnerResponse](docs/A1099/V2/SubstantialUsOwnerResponse.md)
|
236
232
|
- [models.TinMatchStatusResponse](docs/A1099/V2/TinMatchStatusResponse.md)
|
237
233
|
- [models.ValidationError](docs/A1099/V2/ValidationError.md)
|
238
|
-
- [models.W4FormDataModel](docs/A1099/V2/W4FormDataModel.md)
|
239
234
|
- [models.W4FormMinimalRequest](docs/A1099/V2/W4FormMinimalRequest.md)
|
240
235
|
- [models.W4FormRequest](docs/A1099/V2/W4FormRequest.md)
|
241
236
|
- [models.W4FormResponse](docs/A1099/V2/W4FormResponse.md)
|
242
237
|
- [models.W8BenEFormMinimalRequest](docs/A1099/V2/W8BenEFormMinimalRequest.md)
|
243
238
|
- [models.W8BenEFormRequest](docs/A1099/V2/W8BenEFormRequest.md)
|
244
239
|
- [models.W8BenEFormResponse](docs/A1099/V2/W8BenEFormResponse.md)
|
245
|
-
- [models.W8BenESubstantialUsOwnerDataModel](docs/A1099/V2/W8BenESubstantialUsOwnerDataModel.md)
|
246
|
-
- [models.W8BenFormDataModel](docs/A1099/V2/W8BenFormDataModel.md)
|
247
240
|
- [models.W8BenFormMinimalRequest](docs/A1099/V2/W8BenFormMinimalRequest.md)
|
248
241
|
- [models.W8BenFormRequest](docs/A1099/V2/W8BenFormRequest.md)
|
249
242
|
- [models.W8BenFormResponse](docs/A1099/V2/W8BenFormResponse.md)
|
250
|
-
- [models.W8BeneFormDataModel](docs/A1099/V2/W8BeneFormDataModel.md)
|
251
|
-
- [models.W8ImyFormDataModel](docs/A1099/V2/W8ImyFormDataModel.md)
|
252
243
|
- [models.W8ImyFormMinimalRequest](docs/A1099/V2/W8ImyFormMinimalRequest.md)
|
253
244
|
- [models.W8ImyFormRequest](docs/A1099/V2/W8ImyFormRequest.md)
|
254
245
|
- [models.W8ImyFormResponse](docs/A1099/V2/W8ImyFormResponse.md)
|
255
246
|
- [models.W9FormBaseMinimalRequest](docs/A1099/V2/W9FormBaseMinimalRequest.md)
|
256
247
|
- [models.W9FormBaseRequest](docs/A1099/V2/W9FormBaseRequest.md)
|
257
248
|
- [models.W9FormBaseResponse](docs/A1099/V2/W9FormBaseResponse.md)
|
258
|
-
- [models.W9FormDataModel](docs/A1099/V2/W9FormDataModel.md)
|
259
249
|
- [models.W9FormMinimalRequest](docs/A1099/V2/W9FormMinimalRequest.md)
|
260
250
|
- [models.W9FormRequest](docs/A1099/V2/W9FormRequest.md)
|
261
251
|
- [models.W9FormResponse](docs/A1099/V2/W9FormResponse.md)
|
@@ -39,9 +39,9 @@ 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: 'a607ad38-398e-43d2-918d-d809e43dbd6b', # 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
|
}
|
46
46
|
|
47
47
|
begin
|
@@ -78,7 +78,7 @@ end
|
|
78
78
|
| **avalara_version** | **String** | API version | |
|
79
79
|
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
80
80
|
| **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] |
|
81
|
-
| **
|
81
|
+
| **company_request** | [**CompanyRequest**](CompanyRequest.md) | The company to create | [optional] |
|
82
82
|
|
83
83
|
### Return type
|
84
84
|
|
@@ -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: '54780530-dee1-472f-8626-a1ef1d6f3bfa', # 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: '7ee6e06e-ae28-4317-9053-d966f0b24a94', # 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: 'c2254966-bcae-4b32-a7b4-67f0518ca748', # 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,9 +381,9 @@ 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: 'b730ea19-59f4-4cc8-8ef0-94a9d4637a6a', # 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
|
}
|
388
388
|
|
389
389
|
begin
|
@@ -421,7 +421,7 @@ end
|
|
421
421
|
| **avalara_version** | **String** | API version | |
|
422
422
|
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
423
423
|
| **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] |
|
424
|
-
| **
|
424
|
+
| **company_request** | [**CompanyRequest**](CompanyRequest.md) | The updated company data | [optional] |
|
425
425
|
|
426
426
|
### Return type
|
427
427
|
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# AvalaraSdk::A1099::V2::CompanyBase
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Legal name. Not the DBA name. | |
|
8
|
+
| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. | [optional] |
|
9
|
+
| **email** | **String** | Contact email address. For inquiries by vendors/employees. | |
|
10
|
+
| **address** | **String** | Address. | |
|
11
|
+
| **city** | **String** | City. | |
|
12
|
+
| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional] |
|
13
|
+
| **zip** | **String** | ZIP/postal code. | |
|
14
|
+
| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). | |
|
15
|
+
| **tin** | **String** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). | |
|
16
|
+
| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] |
|
17
|
+
| **do_tin_match** | **Boolean** | Indicates whether the company authorizes IRS TIN matching. | [optional] |
|
18
|
+
| **group_name** | **String** | Group name for organizing companies (creates or finds group by name). | [optional] |
|
19
|
+
| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
20
|
+
| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | |
|
21
|
+
| **resend_requests** | **Boolean** | Boolean to enable automatic reminder emails (default: false). | [optional] |
|
22
|
+
| **resend_interval_days** | **Integer** | Days between reminder emails (7-365, required if resendRequests is true). | [optional] |
|
23
|
+
| **max_reminder_attempts** | **Integer** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional] |
|
24
|
+
|
25
|
+
## Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'avalara_sdk'
|
29
|
+
|
30
|
+
instance = AvalaraSdk::A1099::V2::CompanyBase.new(
|
31
|
+
name: null,
|
32
|
+
dba_name: null,
|
33
|
+
email: null,
|
34
|
+
address: null,
|
35
|
+
city: null,
|
36
|
+
state: null,
|
37
|
+
zip: null,
|
38
|
+
telephone: null,
|
39
|
+
tin: null,
|
40
|
+
reference_id: null,
|
41
|
+
do_tin_match: null,
|
42
|
+
group_name: null,
|
43
|
+
foreign_province: null,
|
44
|
+
country_code: null,
|
45
|
+
resend_requests: null,
|
46
|
+
resend_interval_days: null,
|
47
|
+
max_reminder_attempts: null
|
48
|
+
)
|
49
|
+
```
|
50
|
+
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# AvalaraSdk::A1099::V2::CompanyRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Legal name. Not the DBA name. | |
|
8
|
+
| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. | [optional] |
|
9
|
+
| **email** | **String** | Contact email address. For inquiries by vendors/employees. | |
|
10
|
+
| **address** | **String** | Address. | |
|
11
|
+
| **city** | **String** | City. | |
|
12
|
+
| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional] |
|
13
|
+
| **zip** | **String** | ZIP/postal code. | |
|
14
|
+
| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). | |
|
15
|
+
| **tin** | **String** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). | |
|
16
|
+
| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] |
|
17
|
+
| **do_tin_match** | **Boolean** | Indicates whether the company authorizes IRS TIN matching. | [optional] |
|
18
|
+
| **group_name** | **String** | Group name for organizing companies (creates or finds group by name). | [optional] |
|
19
|
+
| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
20
|
+
| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | |
|
21
|
+
| **resend_requests** | **Boolean** | Boolean to enable automatic reminder emails (default: false). | [optional] |
|
22
|
+
| **resend_interval_days** | **Integer** | Days between reminder emails (7-365, required if resendRequests is true). | [optional] |
|
23
|
+
| **max_reminder_attempts** | **Integer** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional] |
|
24
|
+
|
25
|
+
## Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'avalara_sdk'
|
29
|
+
|
30
|
+
instance = AvalaraSdk::A1099::V2::CompanyRequest.new(
|
31
|
+
name: null,
|
32
|
+
dba_name: null,
|
33
|
+
email: null,
|
34
|
+
address: null,
|
35
|
+
city: null,
|
36
|
+
state: null,
|
37
|
+
zip: null,
|
38
|
+
telephone: null,
|
39
|
+
tin: null,
|
40
|
+
reference_id: null,
|
41
|
+
do_tin_match: null,
|
42
|
+
group_name: null,
|
43
|
+
foreign_province: null,
|
44
|
+
country_code: null,
|
45
|
+
resend_requests: null,
|
46
|
+
resend_interval_days: null,
|
47
|
+
max_reminder_attempts: null
|
48
|
+
)
|
49
|
+
```
|
50
|
+
|
data/docs/A1099/V2/Form1042S.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **tin_type** | **String** | | [optional][readonly] |
|
7
|
+
| **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] |
|
8
8
|
| **unique_form_id** | **String** | Unique form identifier | |
|
9
9
|
| **recipient_date_of_birth** | **Date** | Recipient's date of birth | [optional] |
|
10
10
|
| **recipient_giin** | **String** | Recipient's Global Intermediary Identification Number (GIIN). A valid GIIN looks like 'XXXXXX.XXXXX.XX.XXX'. | [optional] |
|
@@ -24,16 +24,16 @@
|
|
24
24
|
| **tax_withheld_other_agents** | **Float** | Tax withheld by other agents | [optional] |
|
25
25
|
| **amount_repaid** | **Float** | Amount repaid to recipient | [optional] |
|
26
26
|
| **tax_paid_agent** | **Float** | Tax paid by withholding agent | [optional] |
|
27
|
-
| **chap3_status_code** | **String** | Chapter 3 status code - Required if WithholdingIndicator is 3 (Chapter 3)
|
28
|
-
| **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.
|
27
|
+
| **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] |
|
28
|
+
| **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] |
|
29
29
|
| **primary_withholding_agent** | [**PrimaryWithholdingAgent**](PrimaryWithholdingAgent.md) | Primary withholding agent information | [optional] |
|
30
30
|
| **intermediary_or_flow_through** | [**IntermediaryOrFlowThrough**](IntermediaryOrFlowThrough.md) | Intermediary or flow-through entity information | [optional] |
|
31
|
-
| **type** | **String** | Form type | |
|
31
|
+
| **type** | **String** | Form type. | |
|
32
32
|
| **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] |
|
33
33
|
| **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] |
|
34
|
-
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] |
|
34
|
+
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] |
|
35
35
|
| **issuer_tin** | **String** | Issuer TIN - readonly | [optional] |
|
36
|
-
| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] |
|
36
|
+
| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] |
|
37
37
|
| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] |
|
38
38
|
| **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] |
|
39
39
|
| **recipient_name** | **String** | Recipient name | |
|
@@ -48,21 +48,21 @@
|
|
48
48
|
| **office_code** | **String** | Office code | [optional] |
|
49
49
|
| **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
50
50
|
| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | |
|
51
|
-
| **federal_efile_date** | **Date** | Date when federal e-filing should be scheduled
|
51
|
+
| **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] |
|
52
52
|
| **postal_mail** | **Boolean** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] |
|
53
|
-
| **state_efile_date** | **Date** | Date when state e-filing should be scheduled
|
54
|
-
| **recipient_edelivery_date** | **Date** | Date when recipient e-delivery should be scheduled
|
53
|
+
| **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] |
|
54
|
+
| **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] |
|
55
55
|
| **tin_match** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] |
|
56
56
|
| **no_tin** | **Boolean** | No TIN indicator | [optional] |
|
57
57
|
| **address_verification** | **Boolean** | Boolean indicating that address verification should be scheduled for this form | [optional] |
|
58
58
|
| **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] |
|
59
59
|
| **second_tin_notice** | **Boolean** | Second TIN notice | [optional] |
|
60
|
-
| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] |
|
61
|
-
| **state_efile_status** | [**Array<StateEfileStatusDetail>**](StateEfileStatusDetail.md) | State e-file status | [optional][readonly] |
|
62
|
-
| **postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional][readonly] |
|
63
|
-
| **tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional][readonly] |
|
64
|
-
| **address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional][readonly] |
|
65
|
-
| **e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional][readonly] |
|
60
|
+
| **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] |
|
61
|
+
| **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] |
|
62
|
+
| **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] |
|
63
|
+
| **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] |
|
64
|
+
| **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] |
|
65
|
+
| **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] |
|
66
66
|
| **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] |
|
67
67
|
| **created_at** | **Time** | Date time when the record was created. | [optional][readonly] |
|
68
68
|
| **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] |
|
@@ -97,7 +97,7 @@ instance = AvalaraSdk::A1099::V2::Form1042S.new(
|
|
97
97
|
chap4_status_code: null,
|
98
98
|
primary_withholding_agent: null,
|
99
99
|
intermediary_or_flow_through: null,
|
100
|
-
type:
|
100
|
+
type: null,
|
101
101
|
id: null,
|
102
102
|
issuer_id: null,
|
103
103
|
issuer_reference_id: null,
|
data/docs/A1099/V2/Form1095B.md
CHANGED
@@ -9,18 +9,18 @@
|
|
9
9
|
| **employee_last_name** | **String** | Employee's last name | |
|
10
10
|
| **employee_name_suffix** | **String** | Employee's name suffix | [optional] |
|
11
11
|
| **employee_date_of_birth** | **Date** | Employee's date of birth | [optional] |
|
12
|
-
| **origin_of_health_coverage_code** | **String** | Origin of health coverage code
|
12
|
+
| **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) | |
|
13
13
|
| **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] |
|
14
|
-
| **type** | **String** | Form type | |
|
14
|
+
| **type** | **String** | Form type. | |
|
15
15
|
| **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] |
|
16
16
|
| **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] |
|
17
|
-
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] |
|
17
|
+
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] |
|
18
18
|
| **issuer_tin** | **String** | Issuer TIN - readonly | [optional] |
|
19
|
-
| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] |
|
19
|
+
| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] |
|
20
20
|
| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] |
|
21
21
|
| **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] |
|
22
22
|
| **recipient_name** | **String** | Recipient name | |
|
23
|
-
| **tin_type** | **String** |
|
23
|
+
| **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] |
|
24
24
|
| **recipient_second_name** | **String** | Recipient second name | [optional] |
|
25
25
|
| **address** | **String** | Address. | |
|
26
26
|
| **address2** | **String** | Address line 2. | [optional] |
|
@@ -32,21 +32,21 @@
|
|
32
32
|
| **office_code** | **String** | Office code | [optional] |
|
33
33
|
| **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
34
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
|
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
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
|
38
|
-
| **recipient_edelivery_date** | **Date** | Date when recipient e-delivery should be scheduled
|
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
39
|
| **tin_match** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] |
|
40
40
|
| **no_tin** | **Boolean** | No TIN indicator | [optional] |
|
41
41
|
| **address_verification** | **Boolean** | Boolean indicating that address verification should be scheduled for this form | [optional] |
|
42
42
|
| **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] |
|
43
43
|
| **second_tin_notice** | **Boolean** | Second TIN notice | [optional] |
|
44
|
-
| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] |
|
45
|
-
| **state_efile_status** | [**Array<StateEfileStatusDetail>**](StateEfileStatusDetail.md) | State e-file status | [optional][readonly] |
|
46
|
-
| **postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional][readonly] |
|
47
|
-
| **tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional][readonly] |
|
48
|
-
| **address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional][readonly] |
|
49
|
-
| **e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional][readonly] |
|
44
|
+
| **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] |
|
45
|
+
| **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] |
|
46
|
+
| **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] |
|
47
|
+
| **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] |
|
48
|
+
| **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] |
|
49
|
+
| **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] |
|
50
50
|
| **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] |
|
51
51
|
| **created_at** | **Time** | Date time when the record was created. | [optional][readonly] |
|
52
52
|
| **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] |
|
@@ -64,7 +64,7 @@ instance = AvalaraSdk::A1099::V2::Form1095B.new(
|
|
64
64
|
employee_date_of_birth: null,
|
65
65
|
origin_of_health_coverage_code: null,
|
66
66
|
covered_individuals: null,
|
67
|
-
type:
|
67
|
+
type: null,
|
68
68
|
id: null,
|
69
69
|
issuer_id: null,
|
70
70
|
issuer_reference_id: null,
|
data/docs/A1099/V2/Form1095C.md
CHANGED
@@ -13,16 +13,16 @@
|
|
13
13
|
| **employer_provided_si_coverage** | **Boolean** | Employer provided self-insured coverage | [optional] |
|
14
14
|
| **offer_and_coverages** | [**Array<OfferAndCoverage>**](OfferAndCoverage.md) | Offer and coverage information | |
|
15
15
|
| **covered_individuals** | [**Array<CoveredIndividual>**](CoveredIndividual.md) | Covered individuals information | [optional] |
|
16
|
-
| **type** | **String** | Form type | |
|
16
|
+
| **type** | **String** | Form type. | |
|
17
17
|
| **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] |
|
18
18
|
| **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] |
|
19
|
-
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] |
|
19
|
+
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] |
|
20
20
|
| **issuer_tin** | **String** | Issuer TIN - readonly | [optional] |
|
21
|
-
| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] |
|
21
|
+
| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] |
|
22
22
|
| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] |
|
23
23
|
| **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] |
|
24
24
|
| **recipient_name** | **String** | Recipient name | |
|
25
|
-
| **tin_type** | **String** |
|
25
|
+
| **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] |
|
26
26
|
| **recipient_second_name** | **String** | Recipient second name | [optional] |
|
27
27
|
| **address** | **String** | Address. | |
|
28
28
|
| **address2** | **String** | Address line 2. | [optional] |
|
@@ -34,21 +34,21 @@
|
|
34
34
|
| **office_code** | **String** | Office code | [optional] |
|
35
35
|
| **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
36
36
|
| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | |
|
37
|
-
| **federal_efile_date** | **Date** | Date when federal e-filing should be scheduled
|
37
|
+
| **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] |
|
38
38
|
| **postal_mail** | **Boolean** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] |
|
39
|
-
| **state_efile_date** | **Date** | Date when state e-filing should be scheduled
|
40
|
-
| **recipient_edelivery_date** | **Date** | Date when recipient e-delivery should be scheduled
|
39
|
+
| **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] |
|
40
|
+
| **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] |
|
41
41
|
| **tin_match** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] |
|
42
42
|
| **no_tin** | **Boolean** | No TIN indicator | [optional] |
|
43
43
|
| **address_verification** | **Boolean** | Boolean indicating that address verification should be scheduled for this form | [optional] |
|
44
44
|
| **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] |
|
45
45
|
| **second_tin_notice** | **Boolean** | Second TIN notice | [optional] |
|
46
|
-
| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] |
|
47
|
-
| **state_efile_status** | [**Array<StateEfileStatusDetail>**](StateEfileStatusDetail.md) | State e-file status | [optional][readonly] |
|
48
|
-
| **postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional][readonly] |
|
49
|
-
| **tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional][readonly] |
|
50
|
-
| **address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional][readonly] |
|
51
|
-
| **e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional][readonly] |
|
46
|
+
| **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] |
|
47
|
+
| **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] |
|
48
|
+
| **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] |
|
49
|
+
| **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] |
|
50
|
+
| **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] |
|
51
|
+
| **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] |
|
52
52
|
| **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] |
|
53
53
|
| **created_at** | **Time** | Date time when the record was created. | [optional][readonly] |
|
54
54
|
| **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] |
|
@@ -68,7 +68,7 @@ instance = AvalaraSdk::A1099::V2::Form1095C.new(
|
|
68
68
|
employer_provided_si_coverage: null,
|
69
69
|
offer_and_coverages: null,
|
70
70
|
covered_individuals: null,
|
71
|
-
type:
|
71
|
+
type: null,
|
72
72
|
id: null,
|
73
73
|
issuer_id: null,
|
74
74
|
issuer_reference_id: null,
|
@@ -4,16 +4,16 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** | Form type | |
|
7
|
+
| **type** | **String** | Form type. | |
|
8
8
|
| **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] |
|
9
9
|
| **issuer_id** | **String** | Issuer ID - only required when creating forms | [optional] |
|
10
|
-
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms | [optional] |
|
10
|
+
| **issuer_reference_id** | **String** | Issuer Reference ID - only required when creating forms via $bulk-upsert | [optional] |
|
11
11
|
| **issuer_tin** | **String** | Issuer TIN - readonly | [optional] |
|
12
|
-
| **tax_year** | **Integer** | Tax Year - only required when creating forms | [optional] |
|
12
|
+
| **tax_year** | **Integer** | Tax Year - only required when creating forms via $bulk-upsert | [optional] |
|
13
13
|
| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. | [optional] |
|
14
14
|
| **tin** | **String** | Recipient's Federal Tax Identification Number (TIN). | [optional] |
|
15
15
|
| **recipient_name** | **String** | Recipient name | |
|
16
|
-
| **tin_type** | **String** |
|
16
|
+
| **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] |
|
17
17
|
| **recipient_second_name** | **String** | Recipient second name | [optional] |
|
18
18
|
| **address** | **String** | Address. | |
|
19
19
|
| **address2** | **String** | Address line 2. | [optional] |
|
@@ -25,21 +25,21 @@
|
|
25
25
|
| **office_code** | **String** | Office code | [optional] |
|
26
26
|
| **non_us_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
27
27
|
| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. | |
|
28
|
-
| **federal_efile_date** | **Date** | Date when federal e-filing should be scheduled
|
28
|
+
| **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] |
|
29
29
|
| **postal_mail** | **Boolean** | Boolean indicating that postal mailing to the recipient should be scheduled for this form | [optional] |
|
30
|
-
| **state_efile_date** | **Date** | Date when state e-filing should be scheduled
|
31
|
-
| **recipient_edelivery_date** | **Date** | Date when recipient e-delivery should be scheduled
|
30
|
+
| **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] |
|
31
|
+
| **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] |
|
32
32
|
| **tin_match** | **Boolean** | Boolean indicating that TIN Matching should be scheduled for this form | [optional] |
|
33
33
|
| **no_tin** | **Boolean** | No TIN indicator | [optional] |
|
34
34
|
| **address_verification** | **Boolean** | Boolean indicating that address verification should be scheduled for this form | [optional] |
|
35
35
|
| **state_and_local_withholding** | [**StateAndLocalWithholding**](StateAndLocalWithholding.md) | State and local withholding information | [optional] |
|
36
36
|
| **second_tin_notice** | **Boolean** | Second TIN notice | [optional] |
|
37
|
-
| **federal_efile_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Federal e-file status | [optional][readonly] |
|
38
|
-
| **state_efile_status** | [**Array<StateEfileStatusDetail>**](StateEfileStatusDetail.md) | State e-file status | [optional][readonly] |
|
39
|
-
| **postal_mail_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Postal mail to recipient status | [optional][readonly] |
|
40
|
-
| **tin_match_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | TIN Match status | [optional][readonly] |
|
41
|
-
| **address_verification_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | Address verification status | [optional][readonly] |
|
42
|
-
| **e_delivery_status** | [**Form1099StatusDetail**](Form1099StatusDetail.md) | EDelivery status | [optional][readonly] |
|
37
|
+
| **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] |
|
38
|
+
| **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] |
|
39
|
+
| **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] |
|
40
|
+
| **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] |
|
41
|
+
| **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] |
|
42
|
+
| **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] |
|
43
43
|
| **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Validation errors | [optional][readonly] |
|
44
44
|
| **created_at** | **Time** | Date time when the record was created. | [optional][readonly] |
|
45
45
|
| **updated_at** | **Time** | Date time when the record was last updated. | [optional][readonly] |
|
@@ -50,7 +50,7 @@
|
|
50
50
|
require 'avalara_sdk'
|
51
51
|
|
52
52
|
instance = AvalaraSdk::A1099::V2::Form1099Base.new(
|
53
|
-
type:
|
53
|
+
type: null,
|
54
54
|
id: null,
|
55
55
|
issuer_id: null,
|
56
56
|
issuer_reference_id: null,
|