Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
351 changes: 145 additions & 206 deletions README.md

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/A1099/CompanyCreateUpdateRequestModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional]
**email** | **string** | | [optional]
**address** | **string** | | [optional]
**city** | **string** | | [optional]
**state** | **string** | | [optional]
**zip** | **string** | | [optional]
**telephone** | **string** | | [optional]
**tin** | **string** | | [optional]
**dba_name** | **string** | | [optional]
**reference_id** | **string** | | [optional]
**do_tin_match** | **bool** | | [optional]
**group_name** | **string** | | [optional]
**foreign_province** | **string** | | [optional]
**country_code** | **string** | | [optional]
**resend_requests** | **bool** | | [optional]
**resend_interval_days** | **int** | | [optional]
**max_reminder_attempts** | **int** | | [optional]
**name** | **string** | Legal name. Not the DBA name. |
**dba_name** | **string** | Doing Business As (DBA) name or continuation of a long legal name. | [optional]
**email** | **string** | Contact email address. For inquiries by vendors/employees. |
**address** | **string** | Address. |
**city** | **string** | City. |
**state** | **string** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional]
**zip** | **string** | ZIP/postal code. |
**telephone** | **string** | Contact phone number (must contain at least 10 digits, max 15 characters). |
**tin** | **string** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). |
**reference_id** | **string** | Internal reference ID. Never shown to any agency or recipient. | [optional]
**do_tin_match** | **bool** | Indicates whether the company authorizes IRS TIN matching. | [optional]
**group_name** | **string** | Group name for organizing companies (creates or finds group by name). | [optional]
**foreign_province** | **string** | Province or region for non-US/CA addresses. | [optional]
**country_code** | **string** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. |
**resend_requests** | **bool** | Boolean to enable automatic reminder emails (default: false). | [optional]
**resend_interval_days** | **int** | Days between reminder emails (7-365, required if resendRequests is true). | [optional]
**max_reminder_attempts** | **int** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
40 changes: 20 additions & 20 deletions docs/A1099/CompanyResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional]
**reference_id** | **string** | | [optional]
**group_name** | **string** | | [optional]
**name** | **string** | | [optional]
**dba_name** | **string** | | [optional]
**address** | **string** | | [optional]
**city** | **string** | | [optional]
**state** | **string** | | [optional]
**foreign_province** | **string** | | [optional]
**zip** | **string** | | [optional]
**country_code** | **string** | | [optional]
**email** | **string** | | [optional]
**telephone** | **string** | | [optional]
**tin** | **string** | | [optional]
**do_tin_match** | **bool** | | [optional]
**resend_requests** | **bool** | | [optional]
**resend_interval_days** | **int** | | [optional]
**max_reminder_attempts** | **int** | | [optional]
**created_at** | **\DateTime** | | [optional]
**updated_at** | **\DateTime** | | [optional]
**id** | **string** | Unique identifier set when the record is created. | [optional]
**created_at** | **\DateTime** | Date time when the record was created. | [optional]
**updated_at** | **\DateTime** | 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. | [optional]
**email** | **string** | Contact email address. For inquiries by vendors/employees. |
**address** | **string** | Address. |
**city** | **string** | City. |
**state** | **string** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional]
**zip** | **string** | ZIP/postal code. |
**telephone** | **string** | Contact phone number (must contain at least 10 digits, max 15 characters). |
**tin** | **string** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). |
**reference_id** | **string** | Internal reference ID. Never shown to any agency or recipient. | [optional]
**do_tin_match** | **bool** | Indicates whether the company authorizes IRS TIN matching. | [optional]
**group_name** | **string** | Group name for organizing companies (creates or finds group by name). | [optional]
**foreign_province** | **string** | Province or region for non-US/CA addresses. | [optional]
**country_code** | **string** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. |
**resend_requests** | **bool** | Boolean to enable automatic reminder emails (default: false). | [optional]
**resend_interval_days** | **int** | Days between reminder emails (7-365, required if resendRequests is true). | [optional]
**max_reminder_attempts** | **int** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
28 changes: 28 additions & 0 deletions docs/A1099/CoveredIndividual.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# # CoveredIndividual

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Covered individual's ID | [optional] [readonly]
**first_name** | **string** | Covered individual's first name |
**middle_name** | **string** | Covered individual's middle name | [optional]
**last_name** | **string** | Covered individual's last name |
**name_suffix** | **string** | Covered individual's name suffix | [optional]
**tin** | **string** | Covered individual's Federal Tax Identification Number (TIN).. SSN or ITIN. Required unless unavailable. | [optional]
**birth_date** | **\DateTime** | Covered individual's date of birth - Required when SSN is missing. | [optional]
**covered_all_months** | **bool** | Coverage indicator for all 12 months | [optional]
**covered_january** | **bool** | Coverage indicator for January | [optional]
**covered_february** | **bool** | Coverage indicator for February | [optional]
**covered_march** | **bool** | Coverage indicator for March | [optional]
**covered_april** | **bool** | Coverage indicator for April | [optional]
**covered_may** | **bool** | Coverage indicator for May | [optional]
**covered_june** | **bool** | Coverage indicator for June | [optional]
**covered_july** | **bool** | Coverage indicator for July | [optional]
**covered_august** | **bool** | Coverage indicator for August | [optional]
**covered_september** | **bool** | Coverage indicator for September | [optional]
**covered_october** | **bool** | Coverage indicator for October | [optional]
**covered_november** | **bool** | Coverage indicator for November | [optional]
**covered_december** | **bool** | Coverage indicator for December | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
18 changes: 18 additions & 0 deletions docs/A1099/CreateAndSendW9FormEmailRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# # CreateAndSendW9FormEmailRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **string** | The form type. | [optional] [readonly]
**email** | **string** | The email address of the individual associated with the form. |
**employee_first_name** | **string** | The first name of the employee. |
**employee_last_name** | **string** | The last name of the employee. |
**office_code** | **string** | The office code associated with the form. | [optional]
**company_id** | **string** | The ID of the associated company. |
**reference_id** | **string** | A reference identifier for the form. | [optional]
**name** | **string** | The name of the individual or entity associated with the form. |
**reference_number** | **string** | A reference number for the form. | [optional]
**account_number** | **string** | The account number associated with the form. | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
28 changes: 28 additions & 0 deletions docs/A1099/CreateCompanyRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# # CreateCompanyRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Legal name. Not the DBA name. |
**dba_name** | **string** | Doing Business As (DBA) name or continuation of a long legal name. | [optional]
**email** | **string** | Contact email address. For inquiries by vendors/employees. |
**address** | **string** | Address. |
**city** | **string** | City. |
**state** | **string** | Two-letter US state or Canadian province code (required for US/CA addresses). | [optional]
**zip** | **string** | ZIP/postal code. |
**telephone** | **string** | Contact phone number (must contain at least 10 digits, max 15 characters). |
**tin** | **string** | Federal Tax Identification Number (TIN). EIN/Tax ID (required for US companies). |
**reference_id** | **string** | Internal reference ID. Never shown to any agency or recipient. | [optional]
**do_tin_match** | **bool** | Indicates whether the company authorizes IRS TIN matching. | [optional]
**group_name** | **string** | Group name for organizing companies (creates or finds group by name). | [optional]
**foreign_province** | **string** | Province or region for non-US/CA addresses. | [optional]
**country_code** | **string** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. |
**resend_requests** | **bool** | Boolean to enable automatic reminder emails (default: false). | [optional]
**resend_interval_days** | **int** | Days between reminder emails (7-365, required if resendRequests is true). | [optional]
**max_reminder_attempts** | **int** | Maximum number of reminder attempts (1-52, required if resendRequests is true). | [optional]
**id** | **string** | Unique identifier set when the record is created. | [optional]
**created_at** | **\DateTime** | Date time when the record was created. | [optional]
**updated_at** | **\DateTime** | Date time when the record was last updated. | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
26 changes: 26 additions & 0 deletions docs/A1099/CreateIssuerRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# # CreateIssuerRequest

## 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** | **int** | 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** | **bool** | Indicates if this is the issuer's final year filing. |
**id** | **string** | Unique identifier set when the record is created. | [optional]
**created_at** | **\DateTime** | Date time when the record was created. | [optional]
**updated_at** | **\DateTime** | Date time when the record was last updated. | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
8 changes: 4 additions & 4 deletions docs/A1099/CreateW9Form201Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,17 +97,17 @@ Name | Type | Description | Notes
**excepted_inter_affiliate_ffi_certification** | **bool** | Certifies that the entity is an inter-affiliate FFI meeting all conditions for exemption, including limited account activity and payment interactions within its expanded affiliated group. | [optional]
**sponsored_direct_reporting_nffe_certification** | **bool** | Certifies that the entity is a sponsored direct reporting NFFE. | [optional]
**direct_reporting_nffe_sponsoring_entity** | **string** | The name of the entity that sponsors the direct reporting NFFE. | [optional]
**substantial_us_owners** | [**\AvalaraSDK\ModelA1099V2\SubstantialUsOwnerResponse[]**](SubstantialUsOwnerResponse.md) | The list of substantial U.S. owners of passive NFFE. | [optional]
**substantial_us_owners** | [**\Avalara\SDK\Model\A1099\V2\SubstantialUsOwnerResponse[]**](SubstantialUsOwnerResponse.md) | The list of substantial U.S. owners of passive NFFE. | [optional]
**signer_name** | **string** | The name of the signer. | [optional]
**capacity_to_sign_certification** | **bool** | Certifies signer has the capacity to sign for the beneficial owner. | [optional]
**id** | **string** | The unique identifier for the form. | [optional]
**entry_status** | **string** | The form status. | [optional]
**entry_status_date** | **\DateTime** | The timestamp for the latest status update. | [optional]
**entry_status** | [**\Avalara\SDK\Model\A1099\V2\EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional]
**reference_id** | **string** | A reference identifier for the form. | [optional]
**company_id** | **string** | The ID of the associated company. | [optional]
**display_name** | **string** | The display name associated with the form. | [optional]
**email** | **string** | The email address of the individual associated with the form. | [optional]
**archived** | **bool** | Indicates whether the form is archived. | [optional]
**ancestor_id** | **string** | Form ID of previous version. | [optional]
**signature** | **string** | The signature of the form. | [optional]
**signed_date** | **\DateTime** | The date the form was signed. | [optional]
**e_delivery_consented_at** | **\DateTime** | The date when e-delivery was consented. | [optional]
Expand Down Expand Up @@ -170,6 +170,6 @@ Name | Type | Description | Notes
**account_number** | **string** | The account number associated with the form. | [optional]
**backup_withholding** | **bool** | Indicates whether backup withholding applies. | [optional]
**is1099able** | **bool** | Indicates whether the individual or entity should be issued a 1099 form. | [optional]
**tin_match_status** | [**\AvalaraSDK\ModelA1099V2\TinMatchStatusResponse**](TinMatchStatusResponse.md) | The TIN Match status from IRS. | [optional]
**tin_match_status** | [**\Avalara\SDK\Model\A1099\V2\TinMatchStatusResponse**](TinMatchStatusResponse.md) | The TIN Match status from IRS. | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
8 changes: 4 additions & 4 deletions docs/A1099/CreateW9FormRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ Name | Type | Description | Notes
**tin** | **string** | The taxpayer identification number (TIN). | [optional]
**backup_withholding** | **bool** | Indicates whether backup withholding applies. | [optional]
**is1099able** | **bool** | Indicates whether the individual or entity should be issued a 1099 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** | **\DateTime** | The date when e-delivery was consented. | [optional]
**signature** | **string** | The signature of the form. | [optional]
**company_id** | **string** | The ID of the associated company. |
**reference_id** | **string** | A reference identifier for the form. | [optional]
**email** | **string** | The email address of the individual associated with the form. | [optional]
**citizenship_country** | **string** | The country of citizenship. | [optional]
**disregarded_entity** | **string** | The name of the disregarded entity receiving the payment (if applicable). | [optional]
**entity_type** | **string** | The entity type. | [optional]
Expand Down Expand Up @@ -158,7 +158,7 @@ Name | Type | Description | Notes
**passive_nffe_no_substantial_us_owners_certification** | **bool** | Certifies that the passive NFFE has no substantial U.S. owners or controlling U.S. persons. | [optional]
**passive_nffe_substantial_us_owners_provided_certification** | **bool** | Certifies that the passive NFFE has provided the name, address, and TIN of each substantial U.S. owner or controlling U.S. person. | [optional]
**excepted_inter_affiliate_ffi_certification** | **bool** | Certifies that the entity is an inter-affiliate FFI meeting all conditions for exemption, including limited account activity and payment interactions within its expanded affiliated group. | [optional]
**substantial_us_owners** | [**\AvalaraSDK\ModelA1099V2\SubstantialUsOwnerRequest[]**](SubstantialUsOwnerRequest.md) | The list of substantial U.S. owners of passive NFFE. | [optional]
**substantial_us_owners** | [**\Avalara\SDK\Model\A1099\V2\SubstantialUsOwnerRequest[]**](SubstantialUsOwnerRequest.md) | The list of substantial U.S. owners of passive NFFE. | [optional]
**capacity_to_sign_certification** | **bool** | Certifies signer has the capacity to sign for the beneficial owner. | [optional]
**birthday** | **\DateTime** | The birthday of the individual associated with the form. | [optional]
**employee_first_name** | **string** | The first name of the employee. | [optional]
Expand Down
10 changes: 10 additions & 0 deletions docs/A1099/EntryStatusResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # EntryStatusResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **string** | The form status. | [optional]
**time** | **\DateTime** | The timestamp for the latest status update. | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
2 changes: 1 addition & 1 deletion docs/A1099/ErrorResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **string** | | [optional]
**errors** | [**\AvalaraSDK\ModelA1099V2\ErrorResponseItem[]**](ErrorResponseItem.md) | | [optional]
**errors** | [**\Avalara\SDK\Model\A1099\V2\ErrorResponseItem[]**](ErrorResponseItem.md) | | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
Loading