Skip to content

Commit dddf623

Browse files
svc-developersvc-developer
authored
25.10.1 (#15)
1 parent 277b1ea commit dddf623

24 files changed

+6852
-82
lines changed

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ Class | Method | HTTP request | Description
215215
*FormsW9Api* | [**createW9Form**](docs/A1099/V2/FormsW9Api.md#createw9form) | **POST** /w9/forms | Create a W9/W4/W8 form
216216
*FormsW9Api* | [**deleteW9Form**](docs/A1099/V2/FormsW9Api.md#deletew9form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form
217217
*FormsW9Api* | [**getW9Form**](docs/A1099/V2/FormsW9Api.md#getw9form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form
218+
*FormsW9Api* | [**getW9FormPdf**](docs/A1099/V2/FormsW9Api.md#getw9formpdf) | **GET** /w9/forms/{id}/pdf | Download the PDF for a W9/W4/W8 form.
218219
*FormsW9Api* | [**listW9Forms**](docs/A1099/V2/FormsW9Api.md#listw9forms) | **GET** /w9/forms | List W9/W4/W8 forms
219220
*FormsW9Api* | [**sendW9FormEmail**](docs/A1099/V2/FormsW9Api.md#sendw9formemail) | **POST** /w9/forms/{id}/$send-email | Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
220221
*FormsW9Api* | [**updateW9Form**](docs/A1099/V2/FormsW9Api.md#updatew9form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form

‎docs/A1099/CreateW9FormRequest.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,25 +28,25 @@ Name | Type | Description | Notes
2828
**company_id** | **string** | The ID of the associated company. Required when creating a form. | [optional]
2929
**reference_id** | **string** | A reference identifier for the form. | [optional]
3030
**email** | **string** | The email address of the individual associated with the form. | [optional]
31-
**citizenship_country** | **string** | The country of citizenship. |
31+
**citizenship_country** | **string** | The country of citizenship.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) |
3232
**disregarded_entity** | **string** | The name of the disregarded entity receiving the payment (if applicable). | [optional]
33-
**entity_type** | **string** | The entity type. Available values: - 1: Corporation - 2: Disregarded entity - 3: Partnership - 4: Simple trust - 5: Grantor trust - 6: Complex trust - 7: Estate - 8: Foreign Government - Controlled Entity - 9: Central Bank of Issue - 10: Tax-exempt organization - 11: Private foundation - 12: International organization - 13: Foreign Government - Controlled Integral Part |
34-
**fatca_status** | **string** | The FATCA status. Available values: - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner) - 2: Participating FFI - 3: Reporting Model 1 FFI - 4: Reporting Model 2 FFI - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII) - 6: Sponsored FFI that has not obtained a GIIN - 7: Certified deemed-compliant nonregistering local bank - 8: Certified deemed-compliant FFI with only low-value accounts - 9: Certified deemed-compliant sponsored, closely held investment vehicle - 10: Certified deemed-compliant limited life debt investment entity - 11: Certified deemed-compliant investment advisors and investment managers - 12: Owner-documented FFI - 13: Restricted distributor - 14: Nonreporting IGA FFI - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue - 16: International organization - 17: Exempt retirement plans - 18: Entity wholly owned by exempt beneficial owners - 19: Territory financial institution - 20: Nonfinancial group entity - 21: Excepted nonfinancial start-up company - 22: Excepted nonfinancial entity in liquidation or bankruptcy - 23: 501(c) organization - 24: Nonprofit organization - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation - 26: Excepted territory NFFE - 27: Active NFFE - 28: Passive NFFE - 29: Excepted inter-affiliate FFI - 30: Direct reporting NFFE - 31: Sponsored direct reporting NFFE - 32: Account that is not a financial account |
33+
**entity_type** | **string** | Represents the entity type for tax forms. Each value corresponds to a specific entity classification. - 1: Corporation - 2: Disregarded entity - 3: Partnership - 4: Simple trust - 5: Grantor trust - 6: Complex trust - 7: Estate - 8: Foreign Government - Controlled Entity - 9: Central Bank of Issue - 10: Tax-exempt organization - 11: Private foundation - 12: International organization - 13: Foreign Government - Controlled Integral Part |
34+
**fatca_status** | **string** | Represents the FATCA status types for tax forms. Used for W8-BEN-E forms and FATCA compliance validations. Values correspond to numeric identifiers used in forms. - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner) - 2: Participating FFI - 3: Reporting Model 1 FFI - 4: Reporting Model 2 FFI - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII) - 6: Sponsored FFI that has not obtained a GIIN - 7: Certified deemed-compliant nonregistering local bank - 8: Certified deemed-compliant FFI with only low-value accounts - 9: Certified deemed-compliant sponsored, closely held investment vehicle - 10: Certified deemed-compliant limited life debt investment entity - 11: Certified deemed-compliant investment advisors and investment managers - 12: Owner-documented FFI - 13: Restricted distributor - 14: Nonreporting IGA FFI - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue - 16: International organization - 17: Exempt retirement plans - 18: Entity wholly owned by exempt beneficial owners - 19: Territory financial institution - 20: Nonfinancial group entity - 21: Excepted nonfinancial start-up company - 22: Excepted nonfinancial entity in liquidation or bankruptcy - 23: 501(c) organization - 24: Nonprofit organization - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation - 26: Excepted territory NFFE - 27: Active NFFE - 28: Passive NFFE - 29: Excepted inter-affiliate FFI - 30: Direct reporting NFFE - 31: Sponsored direct reporting NFFE - 32: Account that is not a financial account |
3535
**residence_address** | **string** | The residential address of the individual or entity. | [optional]
3636
**residence_city** | **string** | The city of residence. | [optional]
37-
**residence_state** | **string** | The state of residence. | [optional]
37+
**residence_state** | **string** | The state of residence. Required for US and Canada.. Allowed values: AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO (and 65 more) | [optional]
3838
**residence_zip** | **string** | The ZIP code of the residence. | [optional]
39-
**residence_country** | **string** | The country of residence. |
39+
**residence_country** | **string** | The country of residence.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) |
4040
**residence_is_mailing** | **bool** | Indicates whether the residence address is the mailing address. | [optional]
4141
**mailing_address** | **string** | The mailing address. | [optional]
4242
**mailing_city** | **string** | The city of the mailing address. | [optional]
43-
**mailing_state** | **string** | The state of the mailing address. | [optional]
43+
**mailing_state** | **string** | The state of the mailing address. Required for US and Canada.. Allowed values: AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO (and 65 more) | [optional]
4444
**mailing_zip** | **string** | The ZIP code of the mailing address. | [optional]
45-
**mailing_country** | **string** | The country of the mailing address. |
45+
**mailing_country** | **string** | The country of the mailing address.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) |
4646
**giin** | **string** | The global intermediary identification number (GIIN). | [optional]
4747
**foreign_tin** | **string** | The foreign taxpayer identification number (TIN). | [optional]
4848
**reference_number** | **string** | A reference number for the form. | [optional]
49-
**disregarded_entity_fatca_status** | **string** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Limited Branch - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI | [optional]
49+
**disregarded_entity_fatca_status** | **string** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Branch treated as nonparticipating FFI - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI | [optional]
5050
**disregarded_address** | **string** | The address for disregarded entities. | [optional]
5151
**disregarded_city** | **string** | The city for disregarded entities. | [optional]
5252
**disregarded_state** | **string** | The state for disregarded entities. | [optional]
@@ -139,12 +139,12 @@ Name | Type | Description | Notes
139139
**making_treaty_claim** | **bool** | Indicates whether the entity is making a treaty claim. | [optional]
140140
**foreign_tin_not_required** | **bool** | Indicates whether a foreign TIN is not legally required. | [optional]
141141
**treaty_country_certification** | **bool** | Certifies the beneficial owner's country under the U.S. tax treaty. | [optional]
142-
**treaty_country** | **string** | The country for which the treaty applies. | [optional]
142+
**treaty_country** | **string** | The country for which the treaty applies.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | [optional]
143143
**benefit_limitation_certification** | **bool** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional]
144-
**benefit_limitation** | **string** | The benefit limitation for tax treaty claims. Available values: - 1: Government - 2: Tax exempt pension trust or pension fund - 3: Other tax exempt organization - 4: Publicly traded corporation - 5: Subsidiary of a publicly traded corporation - 6: Company that meets the ownership and base erosion test - 7: Company that meets the derivative benefits test - 8: Company with an item of income that meets active trade or business test - 9: Favorable discretionary determination by the U.S. competent authority received - 10: Other | [optional]
144+
**benefit_limitation** | **string** | The benefit limitation for tax treaty claims. Available values: - 1: Government - 2: Tax exempt pension trust or pension fund - 3: Other tax exempt organization - 4: Publicly traded corporation - 5: Subsidiary of a publicly traded corporation - 6: Company that meets the ownership and base erosion test - 7: Company that meets the derivative benefits test - 8: Company with an item of income that meets active trade or business test - 9: Favorable discretionary determination by the U.S. competent authority received - 10: Other - 11: No LOB article in treaty | [optional]
145145
**qualified_resident_status_certification** | **bool** | Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. | [optional]
146146
**treaty_article** | **string** | The specific article of the treaty being claimed. | [optional]
147-
**withholding_rate** | **string** | The withholding rate applied as per the treaty. | [optional]
147+
**withholding_rate** | **string** | The withholding rate applied as per the treaty. Must be a percentage with up to two decimals (e.g., 12.50, 0).. Allowed values: 0, 0.0, 0.00, 5, 5.5, 10, 12.50, 15, 20, 25 (and 1 more) | [optional]
148148
**income_type** | **string** | The type of income covered by the treaty. | [optional]
149149
**treaty_reasons** | **string** | The reasons for claiming treaty benefits. | [optional]
150150
**owner_documented_ffi_trust_beneficiaries_certification** | **bool** | Certifies that the trust has no contingent or unidentified beneficiaries or designated classes of beneficiaries. | [optional]

‎docs/A1099/V2/CompaniesW9Api.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ $client = new \Avalara\SDK\ApiClient($config);
4040
$apiInstance = new Avalara\SDK\Api\CompaniesW9Api($client);
4141

4242
$avalara_version = 2.0.0; // string | API version
43-
$x_correlation_id = 6df88900-1e19-42cb-b5a0-fc2442681327; // string | Unique correlation Id in a GUID format
43+
$x_correlation_id = e059925d-91f6-4c34-9bcd-2a0e997dd8fa; // string | Unique correlation Id in a GUID format
4444
$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/) .
4545
$company_request = {"name":"Acme Corporation","dbaName":"","email":"[email protected]","address":"123 Business Ave","city":"Phoenix","state":"AZ","zip":"85001","telephone":"602-555-0123","tin":"12-3456789","referenceId":"","doTinMatch":null,"groupName":"","foreignProvince":"","countryCode":"US","resendRequests":null,"resendIntervalDays":null,"maxReminderAttempts":null}; // \Avalara\SDK\Model\A1099\V2\CompanyRequest | The company to create
4646

@@ -108,7 +108,7 @@ $apiInstance = new Avalara\SDK\Api\CompaniesW9Api($client);
108108

109109
$id = 'id_example'; // string | The company to delete
110110
$avalara_version = 2.0.0; // string | API version
111-
$x_correlation_id = 33931030-471d-4055-be36-8dcc3c48c11d; // string | Unique correlation Id in a GUID format
111+
$x_correlation_id = b01f9bff-5e8c-49d6-8c9b-44892e578dc5; // string | Unique correlation Id in a GUID format
112112
$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/) .
113113

114114
try {
@@ -179,7 +179,7 @@ $skip = 56; // int | If nonzero, skip this number of results before returning da
179179
$order_by = 'order_by_example'; // string | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
180180
$count = True; // bool | If true, return the global count of elements in the collection.
181181
$count_only = True; // bool | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
182-
$x_correlation_id = cf08fb7e-1d1c-43e2-a2b8-dfe7be26d43f; // string | Unique correlation Id in a GUID format
182+
$x_correlation_id = 9654708e-0675-4a73-a0fa-5b8016bb2175; // string | Unique correlation Id in a GUID format
183183
$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/) .
184184

185185
try {
@@ -251,7 +251,7 @@ $apiInstance = new Avalara\SDK\Api\CompaniesW9Api($client);
251251

252252
$id = 'id_example'; // string | Id of the company
253253
$avalara_version = 2.0.0; // string | API version
254-
$x_correlation_id = f29e8436-2c45-494b-b537-a22ae251829e; // string | Unique correlation Id in a GUID format
254+
$x_correlation_id = c9747d06-85d9-42ed-a7d2-1438a48a4d33; // string | Unique correlation Id in a GUID format
255255
$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/) .
256256

257257
try {
@@ -318,7 +318,7 @@ $apiInstance = new Avalara\SDK\Api\CompaniesW9Api($client);
318318

319319
$id = 'id_example'; // string | The ID of the company to update
320320
$avalara_version = 2.0.0; // string | API version
321-
$x_correlation_id = 595ee1c9-2b9e-4d5a-8aa6-661b1fe4669f; // string | Unique correlation Id in a GUID format
321+
$x_correlation_id = 0227fcc3-16c4-439b-a4ea-28c316d311ef; // string | Unique correlation Id in a GUID format
322322
$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/) .
323323
$company_request = {"name":"Acme Corporation","dbaName":"","email":"[email protected]","address":"123 Business Ave","city":"Phoenix","state":"AZ","zip":"85001","telephone":"602-555-0123","tin":"12-3456789","referenceId":"","doTinMatch":null,"groupName":"","foreignProvince":"","countryCode":"US","resendRequests":null,"resendIntervalDays":null,"maxReminderAttempts":null}; // \Avalara\SDK\Model\A1099\V2\CompanyRequest | The updated company data
324324

0 commit comments

Comments
 (0)