RubyGems - avalara_sdk - Versions diffs - 25.7.2 → 25.8.0 - Mend

avalara_sdk 25.7.2 → 25.8.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.

Files changed (308) hide show

data/docs/A1099/V2/Issuers1099Api.md CHANGED Viewed

@@ -6,7 +6,7 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
 | ------ | ------------ | ----------- |
 | [**create_issuer**](Issuers1099Api.md#create_issuer) | **POST** /1099/issuers | Create an issuer |
 | [**delete_issuer**](Issuers1099Api.md#delete_issuer) | **DELETE** /1099/issuers/{id} | Delete an issuer |
-| [**get_issuer**](Issuers1099Api.md#get_issuer) | **GET** /1099/issuers/{id} | Get an issuer |
+| [**get_issuer**](Issuers1099Api.md#get_issuer) | **GET** /1099/issuers/{id} | Retrieve an issuer |
 | [**get_issuers**](Issuers1099Api.md#get_issuers) | **GET** /1099/issuers | List issuers |
 | [**update_issuer**](Issuers1099Api.md#update_issuer) | **PUT** /1099/issuers/{id} | Update an issuer |
@@ -17,7 +17,7 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
 Create an issuer
-Create a new issuer
+Create an issuer (also known as a Payer).
 ### Examples
@@ -37,9 +37,9 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
-avalara_version = '2.0' # String | API version
+avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: 'fa8cab77-a162-404b-8bd9-a580287c744f', # String | Unique correlation Id in a GUID format
+  x_correlation_id: 'ce42bd72-2b6a-438a-8e8b-983910339267', # 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
 }
@@ -100,7 +100,7 @@ end
 Delete an issuer
-Delete an issuer
+Delete an issuer (also known as a Payer).
 ### Examples
@@ -121,9 +121,9 @@ api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
 id = 'id_example' # String | Id of the issuer to delete
-avalara_version = '2.0' # String | API version
+avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: 'b341ad72-1306-4af4-9c02-a742c55d8d97', # String | Unique correlation Id in a GUID format
+  x_correlation_id: '706821c8-d3fe-4fb8-82c2-5d6cf92c475e', # 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/) .
 }
@@ -180,9 +180,9 @@ nil (empty response body)
 > <IssuerResponse> get_issuer(id, avalara_version, opts)
-Get an issuer
+Retrieve an issuer
-Get an issuer
+Retrieve an issuer (also known as a Payer).
 ### Examples
@@ -202,15 +202,15 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
-id = 'id_example' # String |
-avalara_version = '2.0' # String | API version
+id = 'id_example' # String | Id of the issuer to retrieve
+avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: '7d676bbe-e39a-4d59-a548-f9a8e026beed', # String | Unique correlation Id in a GUID format
+  x_correlation_id: '14762757-396e-4e07-851b-2b7dd2542250', # 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
-  # Get an issuer
+  # Retrieve an issuer
   result = api_instance.get_issuer(id, avalara_version, opts)
   p result
 rescue AvalaraSdk::ApiError => e
@@ -226,7 +226,7 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
-  # Get an issuer
+  # Retrieve an issuer
   data, status_code, headers = api_instance.get_issuer_with_http_info(id, avalara_version, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -240,7 +240,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
+| **id** | **String** | Id of the issuer to retrieve |  |
 | **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] |
@@ -265,7 +265,7 @@ end
 List issuers
-List issuers for a given tax year. Filterable fields are name, referenceId and taxYear
+List issuers (also known as Payers). Filterable fields are name, referenceId and taxYear.
 ### Examples
@@ -285,7 +285,7 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
-avalara_version = '2.0' # String | API version
+avalara_version = '2.0.0' # String | API version
 opts = {
   filter: 'filter_example', # String | A filter statement to identify specific records to retrieve.  For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>.
   top: 56, # Integer | If zero or greater than 1000, return at most 1000 results.  Otherwise, return this number of results.  Used with skip to provide pagination for large datasets.
@@ -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: '84029679-b1eb-4ebf-8c73-2612f83c1981', # String | Unique correlation Id in a GUID format
+  x_correlation_id: '99c911ff-f4eb-42a8-841d-342a6cd1c7d5', # 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/) .
 }
@@ -358,7 +358,7 @@ end
 Update an issuer
-Update an existing issuer
+Update an issuer (also known as a Payer).
 ### Examples
@@ -378,10 +378,10 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
-id = 'id_example' # String | Id of the issuer to Update
-avalara_version = '2.0' # String | API version
+id = 'id_example' # String | Id of the issuer to update
+avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: '5eac330a-bb0c-4122-9f83-ec27fc871b05', # String | Unique correlation Id in a GUID format
+  x_correlation_id: '092e5597-f724-49e7-bffa-4f1f21cb6236', # 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
 }
@@ -416,7 +416,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Id of the issuer to Update |  |
+| **id** | **String** | Id of the issuer to update |  |
 | **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] |

data/docs/A1099/V2/JobResult.md CHANGED Viewed

@@ -6,22 +6,22 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional] |
 | **type** | **String** |  | [optional] |
-| **dry_run** | **Boolean** |  | [optional] |
-| **upsert** | **Boolean** |  | [optional] |
-| **status** | **String** |  | [optional] |
+| **dry_run** | **Boolean** | Dry run. If &#x60;true&#x60;, this job only simulates the changes but doesn&#39;t actually persist them. | [optional] |
+| **upsert** | **Boolean** | Upsert. If &#x60;true&#x60;, 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] |
+| **status** | **String** | Status of the job | [optional] |
 | **error_message** | **String** |  | [optional] |
-| **total_processed** | **Integer** |  | [optional] |
-| **total_rows** | **Integer** |  | [optional] |
-| **updated_valid** | **Integer** |  | [optional] |
-| **updated_no_email** | **Integer** |  | [optional] |
-| **updated_invalid** | **Integer** |  | [optional] |
-| **skipped_duplicate** | **Integer** |  | [optional] |
-| **skipped_invalid** | **Integer** |  | [optional] |
-| **skipped_multiple_matches** | **Integer** |  | [optional] |
-| **not_found** | **Integer** |  | [optional] |
-| **created_invalid** | **Integer** |  | [optional] |
-| **created_no_email** | **Integer** |  | [optional] |
-| **created_valid** | **Integer** |  | [optional] |
+| **total_processed** | **Integer** | Total number of forms processed | [optional] |
+| **total_rows** | **Integer** | Total number of forms in the request | [optional] |
+| **updated_valid** | **Integer** | Number of forms updated and valid for e-filing and e-delivery | [optional] |
+| **updated_no_email** | **Integer** | Number of forms updated and valid for e-filing but missing email or email is undeliverable | [optional] |
+| **updated_invalid** | **Integer** | Number of forms updated but invalid for e-filing | [optional] |
+| **skipped_duplicate** | **Integer** | Number of forms skipped because they would have updated a record already updated once in the request | [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 | [optional] |
+| **skipped_multiple_matches** | **Integer** | Number of forms skipped because they matched multiple forms | [optional] |
+| **not_found** | **Integer** | Number of forms skipped because no matching form or issuer could be found | [optional] |
+| **created_invalid** | **Integer** | Number of new forms created because no matching form could be found (and &#x60;upsert&#x60; was true) - with errors | [optional] |
+| **created_no_email** | **Integer** | Number of new forms created because no matching form could be found (and &#x60;upsert&#x60; was true) - valid for e-filing but missing email or email is undeliverable | [optional] |
+| **created_valid** | **Integer** | Number of new forms created because no matching form could be found (and &#x60;upsert&#x60; was true) - valid for e-filing and e-delivery | [optional] |
 ## Example

data/docs/A1099/V2/Jobs1099Api.md CHANGED Viewed

@@ -34,9 +34,9 @@ api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::A1099::V2::Jobs1099Api.new api_client
 id = 'id_example' # String | Job id obtained from other API responses, like `/1099/bulk-upsert`.
-avalara_version = '2.0' # String | API version
+avalara_version = '2.0.0' # String | API version
 opts = {
-  x_correlation_id: '3473f78f-f1bd-48ce-8cad-ad651630addb', # String | Unique correlation Id in a GUID format
+  x_correlation_id: '0d84e31f-0d44-4920-9f1b-5daa360e7925', # 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/) .
 }

data/docs/A1099/V2/PrimaryWithholdingAgent.md ADDED Viewed

@@ -0,0 +1,20 @@
+# AvalaraSdk::A1099::V2::PrimaryWithholdingAgent
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_withholding_agent_name** | **String** |  | [optional] |
+| **primary_withholding_agent_ein** | **String** |  | [optional] |
+## Example
+```ruby
+require 'avalara_sdk'
+instance = AvalaraSdk::A1099::V2::PrimaryWithholdingAgent.new(
+  primary_withholding_agent_name: null,
+  primary_withholding_agent_ein: null
+)
+```

data/docs/A1099/V2/PrimaryWithholdingAgentRequest.md ADDED Viewed

@@ -0,0 +1,20 @@
+# AvalaraSdk::A1099::V2::PrimaryWithholdingAgentRequest
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_withholding_agent_name** | **String** |  | [optional] |
+| **primary_withholding_agent_ein** | **String** |  | [optional] |
+## Example
+```ruby
+require 'avalara_sdk'
+instance = AvalaraSdk::A1099::V2::PrimaryWithholdingAgentRequest.new(
+  primary_withholding_agent_name: null,
+  primary_withholding_agent_ein: null
+)
+```

data/docs/A1099/V2/PrimaryWithholdingAgentResponse.md ADDED Viewed

@@ -0,0 +1,20 @@
+# AvalaraSdk::A1099::V2::PrimaryWithholdingAgentResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_withholding_agent_name** | **String** |  | [optional] |
+| **primary_withholding_agent_ein** | **String** |  | [optional] |
+## Example
+```ruby
+require 'avalara_sdk'
+instance = AvalaraSdk::A1099::V2::PrimaryWithholdingAgentResponse.new(
+  primary_withholding_agent_name: null,
+  primary_withholding_agent_ein: null
+)
+```

data/docs/A1099/V2/StateAndLocalWithholdingResponse.md CHANGED Viewed

@@ -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/StateEfileStatusDetailResponse.md ADDED Viewed

@@ -0,0 +1,22 @@
+# AvalaraSdk::A1099::V2::StateEfileStatusDetailResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **time** | **String** |  | [optional] |
+| **jurisdiction** | **String** |  | [optional] |
+## Example
+```ruby
+require 'avalara_sdk'
+instance = AvalaraSdk::A1099::V2::StateEfileStatusDetailResponse.new(
+  status: null,
+  time: null,
+  jurisdiction: null
+)
+```

data/docs/A1099/V2/SubstantialUsOwnerRequest.md ADDED Viewed

@@ -0,0 +1,22 @@
+# AvalaraSdk::A1099::V2::SubstantialUsOwnerRequest
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the substantial U.S. owner of the NFFE. | [optional] |
+| **address** | **String** | The address of the substantial U.S. owner of the NFFE. | [optional] |
+| **tin** | **String** | The taxpayer identification number (TIN) of the substantial U.S. owner of the NFFE. | [optional] |
+## Example
+```ruby
+require 'avalara_sdk'
+instance = AvalaraSdk::A1099::V2::SubstantialUsOwnerRequest.new(
+  name: null,
+  address: null,
+  tin: null
+)
+```

data/docs/A1099/V2/Update1099Form200Response.md CHANGED Viewed

@@ -14,6 +14,7 @@ require 'avalara_sdk'
 AvalaraSdk::A1099::V2::Update1099Form200Response.openapi_one_of
 # =>
 # [
+#   :'Form1042SResponse',
 #   :'Form1099DivResponse',
 #   :'Form1099MiscResponse',
 #   :'Form1099NecResponse',
@@ -31,7 +32,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 require 'avalara_sdk'
 AvalaraSdk::A1099::V2::Update1099Form200Response.build(data)
-# => #<Form1099DivResponse:0x00007fdd4aab02a0>
+# => #<Form1042SResponse:0x00007fdd4aab02a0>
 AvalaraSdk::A1099::V2::Update1099Form200Response.build(data_that_doesnt_match)
 # => nil
@@ -45,6 +46,7 @@ AvalaraSdk::A1099::V2::Update1099Form200Response.build(data_that_doesnt_match)
 #### Return type
+- `Form1042SResponse`
 - `Form1099DivResponse`
 - `Form1099MiscResponse`
 - `Form1099NecResponse`

data/docs/A1099/V2/ValidationErrorResponse.md ADDED Viewed

@@ -0,0 +1,20 @@
+# AvalaraSdk::A1099::V2::ValidationErrorResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | The field containing the error | [optional] |
+| **errors** | **Array&lt;String&gt;** | The list of error messages | [optional] |
+## Example
+```ruby
+require 'avalara_sdk'
+instance = AvalaraSdk::A1099::V2::ValidationErrorResponse.new(
+  field: null,
+  errors: null
+)
+```

data/docs/A1099/V2/W4FormDataModel.md CHANGED Viewed

@@ -120,9 +120,9 @@
 | **certify_box41** | **Boolean** |  | [optional] |
 | **certify_box43** | **Boolean** |  | [optional] |
 | **certify_part29_signature** | **Boolean** |  | [optional] |
-| **part19_formation_or_resolution_date** | **Time** |  | [optional] |
-| **part20_filing_date** | **Time** |  | [optional] |
-| **part21_determination_date** | **Time** |  | [optional] |
+| **part19_formation_or_resolution_date** | **Date** |  | [optional] |
+| **part20_filing_date** | **Date** |  | [optional] |
+| **part21_determination_date** | **Date** |  | [optional] |
 | **substantial_us_owners** | [**Array&lt;W8BenESubstantialUsOwnerDataModel&gt;**](W8BenESubstantialUsOwnerDataModel.md) |  | [optional] |
 | **birthday** | **String** | The birthday of the individual associated with the form. | [optional] |
 | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] |
@@ -201,8 +201,8 @@
 | **certify_box40** | **Boolean** | Indicates certification for box 40. | [optional] |
 | **box41_sponsoring_entity** | **String** | The sponsoring entity information for box 41. | [optional] |
 | **certify_box42** | **Boolean** | Indicates certification for box 42. | [optional] |
-| **box35_formed_on_date** | **Time** |  | [optional] |
-| **box36_filed_on_date** | **Time** |  | [optional] |
+| **box35_formed_on_date** | **Date** |  | [optional] |
+| **box36_filed_on_date** | **Date** |  | [optional] |
 | **tin_match_status** | **String** | The status of the TIN match. | [optional] |
 | **signature** | **String** | The signature itself | [optional] |
 | **business_classification** | **String** | The classification of the business. | [optional] |

data/docs/A1099/V2/W4FormRequest.md ADDED Viewed

@@ -0,0 +1,66 @@
+# AvalaraSdk::A1099::V2::W4FormRequest
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The form type (always \&quot;w4\&quot; for this model). | [optional][readonly] |
+| **employee_first_name** | **String** | The first name of the employee. | [optional] |
+| **employee_middle_name** | **String** | The middle name of the employee. | [optional] |
+| **employee_last_name** | **String** | The last name of the employee. | [optional] |
+| **employee_name_suffix** | **String** | The name suffix of the employee. | [optional] |
+| **tin_type** | **String** | The type of TIN provided. | [optional] |
+| **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
+| **address** | **String** | The address of the employee. | [optional] |
+| **city** | **String** | The city of residence of the employee. | [optional] |
+| **state** | **String** | The state of residence of the employee. | [optional] |
+| **zip** | **String** | The ZIP code of residence of the employee. | [optional] |
+| **marital_status** | **String** | The marital status of the employee. | [optional] |
+| **last_name_differs** | **Boolean** | Indicates whether the last name differs from prior records. | [optional] |
+| **num_allowances** | **Integer** | The number of allowances claimed by the employee. | [optional] |
+| **other_dependents** | **Integer** | The number of dependents other than allowances. | [optional] |
+| **non_job_income** | **Float** | The amount of non-job income. | [optional] |
+| **deductions** | **Float** | The amount of deductions claimed. | [optional] |
+| **additional_withheld** | **Float** | The additional amount withheld. | [optional] |
+| **exempt_from_withholding** | **Boolean** | Indicates whether the employee is exempt from withholding. | [optional] |
+| **office_code** | **String** | The office code associated with the form. | [optional] |
+| **company_id** | **String** | The ID of the associated company. | [optional] |
+| **reference_id** | **String** | A reference identifier for the form. | [optional] |
+| **email** | **String** | The email address of the individual associated with the form. | [optional] |
+| **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
+| **signature** | **String** | The signature of the form. | [optional] |
+## Example
+```ruby
+require 'avalara_sdk'
+instance = AvalaraSdk::A1099::V2::W4FormRequest.new(
+  type: W4,
+  employee_first_name: null,
+  employee_middle_name: null,
+  employee_last_name: null,
+  employee_name_suffix: null,
+  tin_type: null,
+  tin: null,
+  address: null,
+  city: null,
+  state: null,
+  zip: null,
+  marital_status: null,
+  last_name_differs: null,
+  num_allowances: null,
+  other_dependents: null,
+  non_job_income: null,
+  deductions: null,
+  additional_withheld: null,
+  exempt_from_withholding: null,
+  office_code: null,
+  company_id: null,
+  reference_id: null,
+  email: null,
+  e_delivery_consented_at: null,
+  signature: null
+)
+```