avalara_sdk 25.8.2 → 25.9.0

data/docs/A1099/V2/IntermediaryOrFlowThrough.md

@@ -4,17 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **ein** | **String** |  | [optional] |
-| **chap3_status_code** | **String** |  | [optional] |
-| **chap4_status_code** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **giin** | **String** |  | [optional] |
-| **country_code** | **String** |  | [optional] |
-| **foreign_tin** | **String** |  | [optional] |
-| **address** | **String** |  | [optional] |
-| **city** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **zip** | **String** |  | [optional] |
+| **ein** | **String** | EIN (Employer Identification Number) of the intermediary or flow-through entity | [optional] |
+| **chap3_status_code** | **String** | Chapter 3 status code for the intermediary or flow-through entity. Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary | [optional] |
+| **chap4_status_code** | **String** | Chapter 4 status code for the intermediary or flow-through entity. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI | [optional] |
+| **name** | **String** | Name of the intermediary or flow-through entity | [optional] |
+| **giin** | **String** | GIIN (Global Intermediary Identification Number) of the intermediary or flow-through entity | [optional] |
+| **country_code** | **String** | Country code for the intermediary or flow-through entity | [optional] |
+| **foreign_tin** | **String** | Foreign TIN of the intermediary or flow-through entity | [optional] |
+| **address** | **String** | Address of the intermediary or flow-through entity | [optional] |
+| **city** | **String** | City of the intermediary or flow-through entity | [optional] |
+| **state** | **String** | State of the intermediary or flow-through entity | [optional] |
+| **zip** | **String** | Zip code of the intermediary or flow-through entity | [optional] |
 
 ## Example
 

data/docs/A1099/V2/IssuerBase.md

@@ -0,0 +1,46 @@
+# AvalaraSdk::A1099::V2::IssuerBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Legal name. Not the DBA name. |  |
+| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] |
+| **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] |
+| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces. | [optional] |
+| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. |  |
+| **tax_year** | **Integer** | Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. |  |
+| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address. | [optional] |
+| **email** | **String** | Contact email address. For recipient inquiries. |  |
+| **address** | **String** | Address. |  |
+| **city** | **String** | City. |  |
+| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). |  |
+| **zip** | **String** | ZIP/postal code. |  |
+| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
+| **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] |
+| **last_filing** | **Boolean** | Indicates if this is the issuer's final year filing. |  |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::A1099::V2::IssuerBase.new(
+  name: null,
+  dba_name: null,
+  tin: null,
+  reference_id: null,
+  telephone: null,
+  tax_year: null,
+  country_code: null,
+  email: null,
+  address: null,
+  city: null,
+  state: null,
+  zip: null,
+  foreign_province: null,
+  transfer_agent_name: null,
+  last_filing: null
+)
+```
+

data/docs/A1099/V2/IssuerCommand.md

@@ -4,21 +4,21 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Legal name, not DBA | [optional] |
-| **name_dba** | **String** | Optional DBA name or continuation of a long legal name | [optional] |
-| **tin** | **String** | Tax identification number | [optional] |
-| **reference_id** | **String** | Optional identifier for your reference, never shown to any agency or recipient.  We will also prefix download filenames with this value, if present.  Can only include letters, numbers, dashes, underscores and spaces. | [optional] |
-| **telephone** | **String** | Telephone number | [optional] |
-| **tax_year** | **Integer** | Tax year | [optional] |
-| **country_code** | **String** | If there is a transfer agent, use the shipping address of the transfer agent. | [optional] |
-| **email** | **String** | Email address | [optional] |
-| **address** | **String** | Address | [optional] |
-| **city** | **String** | City | [optional] |
-| **state** | **String** | State | [optional] |
-| **zip** | **String** | Zip code | [optional] |
-| **foreign_province** | **String** | Foreign province | [optional] |
-| **transfer_agent_name** | **String** | Transfer Agent's Name | [optional] |
-| **last_filing** | **Boolean** | Last year of filing for this payer | [optional] |
+| **name** | **String** | Legal name. Not the DBA name. |  |
+| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] |
+| **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] |
+| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces. | [optional] |
+| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. |  |
+| **tax_year** | **Integer** | Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. |  |
+| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address. | [optional] |
+| **email** | **String** | Contact email address. For recipient inquiries. |  |
+| **address** | **String** | Address. |  |
+| **city** | **String** | City. |  |
+| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). |  |
+| **zip** | **String** | ZIP/postal code. |  |
+| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
+| **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] |
+| **last_filing** | **Boolean** | Indicates if this is the issuer's final year filing. |  |
 
 ## Example
 
@@ -27,7 +27,7 @@ require 'avalara_sdk'
 
 instance = AvalaraSdk::A1099::V2::IssuerCommand.new(
   name: null,
-  name_dba: null,
+  dba_name: null,
   tin: null,
   reference_id: null,
   telephone: null,

data/docs/A1099/V2/IssuerRequest.md

@@ -0,0 +1,46 @@
+# AvalaraSdk::A1099::V2::IssuerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Legal name. Not the DBA name. |  |
+| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] |
+| **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] |
+| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces. | [optional] |
+| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. |  |
+| **tax_year** | **Integer** | Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. |  |
+| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address. | [optional] |
+| **email** | **String** | Contact email address. For recipient inquiries. |  |
+| **address** | **String** | Address. |  |
+| **city** | **String** | City. |  |
+| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). |  |
+| **zip** | **String** | ZIP/postal code. |  |
+| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
+| **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] |
+| **last_filing** | **Boolean** | Indicates if this is the issuer's final year filing. |  |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::A1099::V2::IssuerRequest.new(
+  name: null,
+  dba_name: null,
+  tin: null,
+  reference_id: null,
+  telephone: null,
+  tax_year: null,
+  country_code: null,
+  email: null,
+  address: null,
+  city: null,
+  state: null,
+  zip: null,
+  foreign_province: null,
+  transfer_agent_name: null,
+  last_filing: null
+)
+```
+

data/docs/A1099/V2/IssuerResponse.md

@@ -4,24 +4,24 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique identifier set when the record is created | [optional][readonly] |
-| **name** | **String** | Legal name, not DBA | [optional] |
-| **name_dba** | **String** | Optional DBA name or continuation of a long legal name | [optional] |
-| **tin** | **String** | Tax identification number | [optional] |
-| **reference_id** | **String** | Optional identifier for your reference, never shown to any agency or recipient.  We will also prefix download filenames with this value, if present.  Can only include letters, numbers, dashes, underscores and spaces. | [optional] |
-| **telephone** | **String** | Telephone number | [optional] |
-| **tax_year** | **Integer** | Tax year | [optional] |
-| **country_code** | **String** | If there is a transfer agent, use the address of the transfer agent. | [optional] |
-| **email** | **String** | Email address | [optional] |
-| **address** | **String** | Address | [optional] |
-| **city** | **String** | City | [optional] |
-| **state** | **String** | State | [optional] |
-| **zip** | **String** | Zip code | [optional] |
-| **foreign_province** | **String** | Foreign province | [optional] |
-| **transfer_agent_name** | **String** | Transfer Agent's Name | [optional] |
-| **last_filing** | **Boolean** | Last year of filing for this payer | [optional] |
-| **created_at** | **Time** | Date time when the issuer was created | [optional][readonly] |
-| **updated_at** | **Time** | Date time when the issuer was updated | [optional][readonly] |
+| **id** | **String** | Unique identifier set when the record is created. | [optional] |
+| **created_at** | **Time** | Date time when the record was created. | [optional] |
+| **updated_at** | **Time** | Date time when the record was last updated. | [optional] |
+| **name** | **String** | Legal name. Not the DBA name. |  |
+| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] |
+| **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] |
+| **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces. | [optional] |
+| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. |  |
+| **tax_year** | **Integer** | Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. |  |
+| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address. | [optional] |
+| **email** | **String** | Contact email address. For recipient inquiries. |  |
+| **address** | **String** | Address. |  |
+| **city** | **String** | City. |  |
+| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). |  |
+| **zip** | **String** | ZIP/postal code. |  |
+| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
+| **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] |
+| **last_filing** | **Boolean** | Indicates if this is the issuer's final year filing. |  |
 
 ## Example
 
@@ -29,24 +29,24 @@
 require 'avalara_sdk'
 
 instance = AvalaraSdk::A1099::V2::IssuerResponse.new(
-  id: 0,
-  name: Acme Corp,
-  name_dba: Second Name Corp,
-  tin: 23-8234555,
-  reference_id: 1891810-9819891,
-  telephone: 520-555-1234,
-  tax_year: 2024,
-  country_code: US,
-  email: roadrunner@acmecorp.com,
-  address: 1234 Meep Meep Blvd,
-  city: Tucson,
-  state: AZ,
-  zip: 35004,
-  foreign_province: 1981981,
-  transfer_agent_name: test,
-  last_filing: false,
+  id: null,
   created_at: null,
-  updated_at: null
+  updated_at: null,
+  name: null,
+  dba_name: null,
+  tin: null,
+  reference_id: null,
+  telephone: null,
+  tax_year: null,
+  country_code: null,
+  email: null,
+  address: null,
+  city: null,
+  state: null,
+  zip: null,
+  foreign_province: null,
+  transfer_agent_name: null,
+  last_filing: null
 )
 ```
 

data/docs/A1099/V2/Issuers1099Api.md

@@ -1,6 +1,6 @@
 # AvalaraSdk::A1099::V2::Issuers1099Api
 
-All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/avalara1099*
+All URIs are relative to *https://api.sbx.avalara.com/avalara1099*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -39,9 +39,9 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
 
 avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: 'd2b38090-a4c9-4170-bc1d-6cc2778b0bd0', # String | Unique correlation Id in a GUID format
+  x_correlation_id: '5c70e4f3-3885-4757-84f3-86323c1af033', # String | Unique correlation Id in a GUID format
   x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
-  issuer_command: AvalaraSdk::A1099::V2::IssuerCommand.new # IssuerCommand | The issuer to create
+  issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to create
 }
 
 begin
@@ -78,7 +78,7 @@ end
 | **avalara_version** | **String** | API version |  |
 | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
 | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
-| **issuer_command** | [**IssuerCommand**](IssuerCommand.md) | The issuer to create | [optional] |
+| **issuer_request** | [**IssuerRequest**](IssuerRequest.md) | The issuer to create | [optional] |
 
 ### Return type
 
@@ -123,7 +123,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
 id = 'id_example' # String | Id of the issuer to delete
 avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: '22e9dc96-0041-4e27-ab37-038dc9d6c215', # String | Unique correlation Id in a GUID format
+  x_correlation_id: 'ebe59aa0-745c-44da-b86b-67ad7994619c', # String | Unique correlation Id in a GUID format
   x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
 }
 
@@ -205,7 +205,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
 id = 'id_example' # String | Id of the issuer to retrieve
 avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: '86c9eff5-1ed3-49b1-be09-a117b235f3e2', # String | Unique correlation Id in a GUID format
+  x_correlation_id: 'cfc604e9-15ae-4c65-a59f-123475fad2ef', # String | Unique correlation Id in a GUID format
   x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
 }
 
@@ -293,7 +293,7 @@ opts = {
   order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
   count: true, # Boolean | If true, return the global count of elements in the collection.
   count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection.  It only applies when count=true.
-  x_correlation_id: '0983f292-e1e0-4415-9cdc-b70482da76b0', # String | Unique correlation Id in a GUID format
+  x_correlation_id: '3302a30f-61fc-4b94-af04-c683c6064eed', # String | Unique correlation Id in a GUID format
   x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
 }
 
@@ -381,9 +381,9 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
 id = 'id_example' # String | Id of the issuer to update
 avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: 'f43f2c52-c35e-4e50-b1ad-2923b624e5a0', # String | Unique correlation Id in a GUID format
+  x_correlation_id: '4f30c58e-f8fd-4635-99d4-ea710f1d0182', # String | Unique correlation Id in a GUID format
   x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
-  issuer_command: AvalaraSdk::A1099::V2::IssuerCommand.new # IssuerCommand | The issuer to update
+  issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to update
 }
 
 begin
@@ -420,7 +420,7 @@ end
 | **avalara_version** | **String** | API version |  |
 | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
 | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
-| **issuer_command** | [**IssuerCommand**](IssuerCommand.md) | The issuer to update | [optional] |
+| **issuer_request** | [**IssuerRequest**](IssuerRequest.md) | The issuer to update | [optional] |
 
 ### Return type
 

data/docs/A1099/V2/JobResponse.md

@@ -0,0 +1,56 @@
+# AvalaraSdk::A1099::V2::JobResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the job | [optional] |
+| **type** | **String** | Job type identifier. Will always be \"update_job\" for bulk upsert operations | [optional] |
+| **status** | **String** | Current status of the job (e.g., Success, Failed, InProgress) | [optional] |
+| **error_message** | **String** | Error message if the job failed, null otherwise | [optional] |
+| **total_processed** | **Integer** | Total number of forms processed. Value can be 0 or another value based on what the job has available | [optional] |
+| **total_rows** | **Integer** | Total number of forms in the request. Value can be 0 or another value based on what the job has available | [optional] |
+| **updated_valid** | **Integer** | Number of forms updated and valid for e-filing and e-delivery. Value can be 0 or another value based on what the job has available | [optional] |
+| **updated_no_email** | **Integer** | Number of forms updated and valid for e-filing but missing email or email is undeliverable. Value can be 0 or another value based on what the job has available | [optional] |
+| **updated_invalid** | **Integer** | Number of forms updated but invalid for e-filing. Value can be 0 or another value based on what the job has available | [optional] |
+| **skipped_duplicate** | **Integer** | Number of forms skipped because they would have updated a record already updated once in the request. Value can be 0 or another value based on what the job has available | [optional] |
+| **skipped_invalid** | **Integer** | Number of forms skipped because they would have made a form invalid and the form is already e-filed or scheduled for e-filing. Value can be 0 or another value based on what the job has available | [optional] |
+| **skipped_multiple_matches** | **Integer** | Number of forms skipped because they matched multiple forms. Value can be 0 or another value based on what the job has available | [optional] |
+| **not_found** | **Integer** | Number of forms skipped because no matching form or issuer could be found. Value can be 0 or another value based on what the job has available | [optional] |
+| **created_invalid** | **Integer** | Number of new forms created because no matching form could be found (and `upsert` was true) - with errors. Value can be 0 or another value based on what the job has available | [optional] |
+| **created_no_email** | **Integer** | Number of new forms created because no matching form could be found (and `upsert` was true) - valid for e-filing but missing email or email is undeliverable. Value can be 0 or another value based on what the job has available | [optional] |
+| **created_valid** | **Integer** | Number of new forms created because no matching form could be found (and `upsert` was true) - valid for e-filing and e-delivery. Value can be 0 or another value based on what the job has available | [optional] |
+| **dry_run** | **Boolean** | Dry run. If `true`, this job only simulates the changes but doesn't actually persist them. | [optional] |
+| **upsert** | **Boolean** | Upsert. If `true`, this job will first attempt to update existing records if matches can be found. Matches are done in the following order: Form ID, Form Reference ID and tax year, Form TIN and tax year. | [optional] |
+| **link** | **String** | Link to access the job details | [optional] |
+| **processed_forms** | [**Array<Get1099Form200Response>**](Get1099Form200Response.md) | List of processed forms returned when bulk-upsert processes ≤1000 records. Same format as GET /1099/forms response. Only available in bulk-upsert endpoint responses. | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::A1099::V2::JobResponse.new(
+  id: null,
+  type: null,
+  status: null,
+  error_message: null,
+  total_processed: null,
+  total_rows: null,
+  updated_valid: null,
+  updated_no_email: null,
+  updated_invalid: null,
+  skipped_duplicate: null,
+  skipped_invalid: null,
+  skipped_multiple_matches: null,
+  not_found: null,
+  created_invalid: null,
+  created_no_email: null,
+  created_valid: null,
+  dry_run: null,
+  upsert: null,
+  link: null,
+  processed_forms: null
+)
+```
+

data/docs/A1099/V2/JobsApi.md

@@ -0,0 +1,91 @@
+# AvalaraSdk::A1099::V2::JobsApi
+
+All URIs are relative to *https://api.sbx.avalara.com/avalara1099*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_job**](JobsApi.md#get_job) | **GET** /jobs/{id} | Retrieves information about the job |
+
+
+## get_job
+
+> <JobResponse> get_job(id, avalara_version, opts)
+
+Retrieves information about the job
+
+Retrieves information about the job
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk::A1099::V2.configure do |config|
+  # See Documentation for Authorization section in main README.md for more auth examples.
+  config.bearer_token='<Your Avalara Identity Access Token>'
+  config.environment='sandbox'
+  config.app_name='testApp'
+  config.app_version='1.2.3'
+  config.machine_name='testMachine'
+end
+
+api_client = AvalaraSdk::ApiClient.new config
+api_instance = AvalaraSdk::A1099::V2::JobsApi.new api_client
+
+id = 'id_example' # String | Job id obtained from other API responses, like `/1099/bulk-upsert`.
+avalara_version = '2.0.0' # String | API version
+opts = {
+  x_correlation_id: 'af6414fe-0bd6-4ddb-91bb-43108aa78fa5', # String | Unique correlation Id in a GUID format
+  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
+}
+
+begin
+  # Retrieves information about the job
+  result = api_instance.get_job(id, avalara_version, opts)
+  p result
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling JobsApi->get_job: #{e}"
+end
+```
+
+#### Using the get_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JobResponse>, Integer, Hash)> get_job_with_http_info(id, avalara_version, opts)
+
+```ruby
+begin
+  # Retrieves information about the job
+  data, status_code, headers = api_instance.get_job_with_http_info(id, avalara_version, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JobResponse>
+rescue AvalaraSdk::A1099::V2::ApiError => e
+  puts "Error when calling JobsApi->get_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Job id obtained from other API responses, like &#x60;/1099/bulk-upsert&#x60;. |  |
+| **avalara_version** | **String** | API version |  |
+| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
+| **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
+
+### Return type
+
+[**JobResponse**](JobResponse.md)
+
+### Authorization
+
+[bearer](../../../README.md#documentation-for-authorization)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/A1099/V2/OfferAndCoverage.md

@@ -0,0 +1,28 @@
+# AvalaraSdk::A1099::V2::OfferAndCoverage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Id | [optional][readonly] |
+| **month** | **String** | Month of coverage.  Available values:  - All: All months  - January: January  - February: February  - March: March  - April: April  - May: May  - June: June  - July: July  - August: August  - September: September  - October: October  - November: November  - December: December | [optional] |
+| **offer_code** | **String** | Offer of Coverage Code. Required if Share has a value, including zero.  Available values:    Pre-ICHRA Codes (available before 2020):  - 1A: Qualifying offer: minimum essential coverage providing minimum value offered to full-time employee with employee required contribution ≤ 9.5% (as adjusted) of mainland single federal poverty line and at least minimum essential coverage offered to spouse and dependent(s)  - 1B: Minimum essential coverage providing minimum value offered to employee only  - 1C: Minimum essential coverage providing minimum value offered to employee and at least minimum essential coverage offered to dependent(s) (not spouse)  - 1D: Minimum essential coverage providing minimum value offered to employee and at least minimum essential coverage offered to spouse (not dependent(s))  - 1E: Minimum essential coverage providing minimum value offered to employee and at least minimum essential coverage offered to dependent(s) and spouse  - 1F: Minimum essential coverage NOT providing minimum value offered to employee; employee and spouse or dependent(s); or employee, spouse, and dependents  - 1G: Offer of coverage to an individual who was not an employee or not a full-time employee and who enrolled in self-insured coverage  - 1H: No offer of coverage (employee not offered any health coverage or employee offered coverage that is not minimum essential coverage)  - 1J: Minimum essential coverage providing minimum value offered to employee and at least minimum essential coverage conditionally offered to spouse; minimum essential coverage not offered to dependent(s)  - 1K: Minimum essential coverage providing minimum value offered to employee; at least minimum essential coverage offered to dependents; and at least minimum essential coverage conditionally offered to spouse                ICHRA Codes (introduced 2020, require ZIP code):  - 1L: Individual coverage HRA offered to employee only  - 1M: Individual coverage HRA offered to employee and dependent(s) (not spouse)  - 1N: Individual coverage HRA offered to employee, spouse, and dependent(s)  - 1O: Individual coverage HRA offered to employee only using employment site ZIP code affordability safe harbor  - 1P: Individual coverage HRA offered to employee and dependent(s) (not spouse) using employment site ZIP code affordability safe harbor  - 1Q: Individual coverage HRA offered to employee, spouse, and dependent(s) using employment site ZIP code affordability safe harbor  - 1R: Individual coverage HRA that is NOT affordable  - 1S: Individual coverage HRA offered to an individual who was not a full-time employee  - 1T: Individual coverage HRA offered to employee and spouse (not dependents)  - 1U: Individual coverage HRA offered to employee and spouse (not dependents) using employment site ZIP code affordability safe harbor    Note: Codes 1B, 1C, 1D, 1E, 1J, 1K, 1L, 1M, 1N, 1O, 1P, 1Q, 1T, 1U require employee share amount (0.00 is a valid value). | [optional] |
+| **share** | **Float** | Employee required contribution share - Employee Share of Lowest Cost Monthly Premium, for Self-Only Minimum Value Coverage - May not exceed 3499.99 | [optional] |
+| **safe_harbor_code** | **String** | Safe harbor code - Applicable Section 4980H Safe Harbor Code.  Available values:  - 2A: Form W-2 safe harbor  - 2B: Federal poverty line safe harbor  - 2C: Rate of pay safe harbor  - 2D: Part-time employee safe harbor for employees who were not full-time for any month of the year  - 2E: Multiemployer interim rule relief  - 2F: Qualifying offer method  - 2G: Qualifying offer transition relief  - 2H: Other affordability safe harbor | [optional] |
+| **zip_code** | **String** | ZIP/postal code. For coverage area (optional, unless codes 1L to 1U are used). | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::A1099::V2::OfferAndCoverage.new(
+  id: null,
+  month: null,
+  offer_code: null,
+  share: null,
+  safe_harbor_code: null,
+  zip_code: null
+)
+```
+

data/docs/A1099/V2/PaginatedQueryResultModelForm1099Base.md

@@ -0,0 +1,22 @@
+# AvalaraSdk::A1099::V2::PaginatedQueryResultModelForm1099Base
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recordset_count** | **Integer** |  | [optional] |
+| **value** | [**Array<Get1099Form200Response>**](Get1099Form200Response.md) |  | [optional] |
+| **next_link** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::A1099::V2::PaginatedQueryResultModelForm1099Base.new(
+  recordset_count: null,
+  value: null,
+  next_link: null
+)
+```
+

data/docs/A1099/V2/PrimaryWithholdingAgent.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **primary_withholding_agent_name** | **String** |  | [optional] |
-| **primary_withholding_agent_ein** | **String** |  | [optional] |
+| **name** | **String** | Name of the primary withholding agent |  |
+| **ein** | **String** | EIN (Employer Identification Number) of the primary withholding agent. |  |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'avalara_sdk'
 
 instance = AvalaraSdk::A1099::V2::PrimaryWithholdingAgent.new(
-  primary_withholding_agent_name: null,
-  primary_withholding_agent_ein: null
+  name: null,
+  ein: null
 )
 ```
 

data/docs/A1099/V2/StateAndLocalWithholding.md

@@ -4,14 +4,14 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **state_tax_withheld** | **Float** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **state_id_number** | **String** |  | [optional] |
-| **state_income** | **Float** |  | [optional] |
-| **local_tax_withheld** | **Float** |  | [optional] |
-| **locality** | **String** |  | [optional] |
-| **locality_id_number** | **String** |  | [optional] |
-| **local_income** | **Float** |  | [optional] |
+| **state_tax_withheld** | **Float** | Amount of state tax that was withheld | [optional] |
+| **state** | **String** | US state | [optional] |
+| **state_id_number** | **String** | State ID number of the entity issuing the form | [optional] |
+| **state_income** | **Float** | Amount of state income | [optional] |
+| **local_tax_withheld** | **Float** | Amount of local tax that was withheld | [optional] |
+| **locality** | **String** | Locality name | [optional] |
+| **locality_id_number** | **String** | Locality ID number of the entity issuing the form | [optional] |
+| **local_income** | **Float** | Amount of local income | [optional] |
 
 ## Example
 

data/docs/A1099/V2/TinMatchStatusResponse.md

@@ -15,7 +15,7 @@ require 'avalara_sdk'
 
 instance = AvalaraSdk::A1099::V2::TinMatchStatusResponse.new(
   time: null,
-  status: None,
+  status: null,
   irs_response: null
 )
 ```

data/docs/A1099/V2/ValidationError.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **field** | **String** |  | [optional] |
-| **errors** | **Array<String>** |  | [optional] |
+| **field** | **String** | The field containing the error | [optional] |
+| **errors** | **Array<String>** | The list of error messages | [optional] |
 
 ## Example