diff --git a/README.md b/README.md index beac2fe..73e8dd4 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,7 @@ Class | Method | HTTP request | Description *FormsW9Api* | [**createW9Form**](docs/A1099/V2/FormsW9Api.md#createw9form) | **POST** /w9/forms | Create a W9/W4/W8 form *FormsW9Api* | [**deleteW9Form**](docs/A1099/V2/FormsW9Api.md#deletew9form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form *FormsW9Api* | [**getW9Form**](docs/A1099/V2/FormsW9Api.md#getw9form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form +*FormsW9Api* | [**getW9FormPdf**](docs/A1099/V2/FormsW9Api.md#getw9formpdf) | **GET** /w9/forms/{id}/pdf | Download the PDF for a W9/W4/W8 form. *FormsW9Api* | [**listW9Forms**](docs/A1099/V2/FormsW9Api.md#listw9forms) | **GET** /w9/forms | List W9/W4/W8 forms *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 *FormsW9Api* | [**updateW9Form**](docs/A1099/V2/FormsW9Api.md#updatew9form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form diff --git a/docs/A1099/V2/CompaniesW9Api.md b/docs/A1099/V2/CompaniesW9Api.md index 96ba1ca..fc5ca31 100644 --- a/docs/A1099/V2/CompaniesW9Api.md +++ b/docs/A1099/V2/CompaniesW9Api.md @@ -49,7 +49,7 @@ public class Example { CompaniesW9Api apiInstance = new CompaniesW9Api(apiClient); String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "6df88900-1e19-42cb-b5a0-fc2442681327"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "e059925d-91f6-4c34-9bcd-2a0e997dd8fa"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . CompanyRequest companyRequest = new CompanyRequest(); // CompanyRequest | The company to create try { @@ -136,7 +136,7 @@ public class Example { CompaniesW9Api apiInstance = new CompaniesW9Api(apiClient); String id = "id_example"; // String | The company to delete String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "33931030-471d-4055-be36-8dcc3c48c11d"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "b01f9bff-5e8c-49d6-8c9b-44892e578dc5"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { apiInstance.deleteCompany(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -228,7 +228,7 @@ public class Example { String $orderBy = "$orderBy_example"; // String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. Boolean count = true; // Boolean | If true, return the global count of elements in the collection. Boolean countOnly = true; // Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true. - String xCorrelationId = "cf08fb7e-1d1c-43e2-a2b8-dfe7be26d43f"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "9654708e-0675-4a73-a0fa-5b8016bb2175"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { PaginatedQueryResultModelCompanyResponse result = apiInstance.getCompanies(avalaraVersion, $filter, $top, $skip, $orderBy, count, countOnly, xCorrelationId, xAvalaraClient); @@ -321,7 +321,7 @@ public class Example { CompaniesW9Api apiInstance = new CompaniesW9Api(apiClient); String id = "id_example"; // String | Id of the company String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "f29e8436-2c45-494b-b537-a22ae251829e"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "c9747d06-85d9-42ed-a7d2-1438a48a4d33"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { CompanyResponse result = apiInstance.getCompany(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -409,7 +409,7 @@ public class Example { CompaniesW9Api apiInstance = new CompaniesW9Api(apiClient); String id = "id_example"; // String | The ID of the company to update String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "595ee1c9-2b9e-4d5a-8aa6-661b1fe4669f"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "0227fcc3-16c4-439b-a4ea-28c316d311ef"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . CompanyRequest companyRequest = new CompanyRequest(); // CompanyRequest | The updated company data try { diff --git a/docs/A1099/V2/CreateW9FormRequest.md b/docs/A1099/V2/CreateW9FormRequest.md index 9f4dac7..4588fba 100644 --- a/docs/A1099/V2/CreateW9FormRequest.md +++ b/docs/A1099/V2/CreateW9FormRequest.md @@ -31,28 +31,28 @@ |**companyId** | **String** | The ID of the associated company. Required when creating a form. | [optional] | |**referenceId** | **String** | A reference identifier for the form. | [optional] | |**email** | **String** | The email address of the individual associated with the form. | [optional] | -|**citizenshipCountry** | **String** | The country of citizenship. | | +|**citizenshipCountry** | [**CitizenshipCountryEnum**](#CitizenshipCountryEnum) | The country of citizenship.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | | |**disregardedEntity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] | -|**entityType** | **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 | | -|**fatcaStatus** | **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 | | +|**entityType** | [**EntityTypeEnum**](#EntityTypeEnum) | 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 | | +|**fatcaStatus** | [**FatcaStatusEnum**](#FatcaStatusEnum) | 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 | | |**residenceAddress** | **String** | The residential address of the individual or entity. | [optional] | |**residenceCity** | **String** | The city of residence. | [optional] | -|**residenceState** | **String** | The state of residence. | [optional] | +|**residenceState** | [**ResidenceStateEnum**](#ResidenceStateEnum) | 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] | |**residenceZip** | **String** | The ZIP code of the residence. | [optional] | -|**residenceCountry** | **String** | The country of residence. | | +|**residenceCountry** | [**ResidenceCountryEnum**](#ResidenceCountryEnum) | The country of residence.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | | |**residenceIsMailing** | **Boolean** | Indicates whether the residence address is the mailing address. | [optional] | |**mailingAddress** | **String** | The mailing address. | [optional] | |**mailingCity** | **String** | The city of the mailing address. | [optional] | -|**mailingState** | **String** | The state of the mailing address. | [optional] | +|**mailingState** | [**MailingStateEnum**](#MailingStateEnum) | 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] | |**mailingZip** | **String** | The ZIP code of the mailing address. | [optional] | -|**mailingCountry** | **String** | The country of the mailing address. | | +|**mailingCountry** | [**MailingCountryEnum**](#MailingCountryEnum) | The country of the mailing address.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | | |**giin** | **String** | The global intermediary identification number (GIIN). | [optional] | |**foreignTin** | **String** | The foreign taxpayer identification number (TIN). | [optional] | |**referenceNumber** | **String** | A reference number for the form. | [optional] | -|**disregardedEntityFatcaStatus** | **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] | +|**disregardedEntityFatcaStatus** | [**DisregardedEntityFatcaStatusEnum**](#DisregardedEntityFatcaStatusEnum) | 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] | |**disregardedAddress** | **String** | The address for disregarded entities. | [optional] | |**disregardedCity** | **String** | The city for disregarded entities. | [optional] | -|**disregardedState** | **String** | The state for disregarded entities. | [optional] | +|**disregardedState** | [**DisregardedStateEnum**](#DisregardedStateEnum) | The state for disregarded entities. | [optional] | |**disregardedZip** | **String** | The ZIP code for disregarded entities. | [optional] | |**disregardedCountry** | **String** | The country for disregarded entities. | [optional] | |**disregardedEntityGiin** | **String** | The GIIN for disregarded entities. | [optional] | @@ -113,7 +113,7 @@ |**foreignCentralBankOfIssueCertification** | **Boolean** | Certifies that the entity is treated as the beneficial owner of the payment solely for purposes of chapter 4 under Regulations section 1.1471-6(d)(4). | [optional] | |**nonreportingIgaFfiCertification** | **Boolean** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] | |**igaCountry** | **String** | The country for the applicable IGA with the United States. | [optional] | -|**igaModel** | **String** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] | +|**igaModel** | [**IgaModelEnum**](#IgaModelEnum) | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] | |**igaLegalStatusTreatment** | **String** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] | |**igaFfiTrusteeOrSponsor** | **String** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] | |**igaFfiTrusteeIsForeign** | **Boolean** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] | @@ -142,12 +142,12 @@ |**makingTreatyClaim** | **Boolean** | Indicates whether the entity is making a treaty claim. | [optional] | |**foreignTinNotRequired** | **Boolean** | Indicates whether a foreign TIN is not legally required. | [optional] | |**treatyCountryCertification** | **Boolean** | Certifies the beneficial owner's country under the U.S. tax treaty. | [optional] | -|**treatyCountry** | **String** | The country for which the treaty applies. | [optional] | +|**treatyCountry** | [**TreatyCountryEnum**](#TreatyCountryEnum) | The country for which the treaty applies.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | [optional] | |**benefitLimitationCertification** | **Boolean** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional] | -|**benefitLimitation** | **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] | +|**benefitLimitation** | [**BenefitLimitationEnum**](#BenefitLimitationEnum) | 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] | |**qualifiedResidentStatusCertification** | **Boolean** | Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. | [optional] | |**treatyArticle** | **String** | The specific article of the treaty being claimed. | [optional] | -|**withholdingRate** | **String** | The withholding rate applied as per the treaty. | [optional] | +|**withholdingRate** | [**WithholdingRateEnum**](#WithholdingRateEnum) | 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] | |**incomeType** | **String** | The type of income covered by the treaty. | [optional] | |**treatyReasons** | **String** | The reasons for claiming treaty benefits. | [optional] | |**ownerDocumentedFfiTrustBeneficiariesCertification** | **Boolean** | Certifies that the trust has no contingent or unidentified beneficiaries or designated classes of beneficiaries. | [optional] | @@ -277,6 +277,1415 @@ +## Enum: CitizenshipCountryEnum + +| Name | Value | +|---- | -----| +| US | "US" | +| AF | "AF" | +| AX | "AX" | +| AL | "AL" | +| AG | "AG" | +| AQ | "AQ" | +| AN | "AN" | +| AO | "AO" | +| AV | "AV" | +| AY | "AY" | +| AC | "AC" | +| AR | "AR" | +| AM | "AM" | +| AA | "AA" | +| AT | "AT" | +| AS | "AS" | +| AU | "AU" | +| AJ | "AJ" | +| BF | "BF" | +| BA | "BA" | +| FQ | "FQ" | +| BG | "BG" | +| BB | "BB" | +| BO | "BO" | +| BE | "BE" | +| BH | "BH" | +| BN | "BN" | +| BD | "BD" | +| BT | "BT" | +| BL | "BL" | +| BK | "BK" | +| BC | "BC" | +| BV | "BV" | +| BR | "BR" | +| IO | "IO" | +| VI | "VI" | +| BX | "BX" | +| BU | "BU" | +| UV | "UV" | +| BM | "BM" | +| BY | "BY" | +| CB | "CB" | +| CM | "CM" | +| CA | "CA" | +| CV | "CV" | +| CJ | "CJ" | +| CT | "CT" | +| CD | "CD" | +| CI | "CI" | +| CH | "CH" | +| KT | "KT" | +| IP | "IP" | +| CK | "CK" | +| CO | "CO" | +| CN | "CN" | +| CF | "CF" | +| CG | "CG" | +| CW | "CW" | +| CR | "CR" | +| CS | "CS" | +| IV | "IV" | +| HR | "HR" | +| CU | "CU" | +| UC | "UC" | +| CY | "CY" | +| EZ | "EZ" | +| DA | "DA" | +| DX | "DX" | +| DJ | "DJ" | +| DO | "DO" | +| DR | "DR" | +| TT | "TT" | +| EC | "EC" | +| EG | "EG" | +| ES | "ES" | +| EK | "EK" | +| ER | "ER" | +| EN | "EN" | +| ET | "ET" | +| FK | "FK" | +| FO | "FO" | +| FM | "FM" | +| FJ | "FJ" | +| FI | "FI" | +| FR | "FR" | +| FP | "FP" | +| FS | "FS" | +| GB | "GB" | +| GA | "GA" | +| GG | "GG" | +| GM | "GM" | +| GH | "GH" | +| GI | "GI" | +| GR | "GR" | +| GL | "GL" | +| GJ | "GJ" | +| GQ | "GQ" | +| GT | "GT" | +| GK | "GK" | +| GV | "GV" | +| PU | "PU" | +| GY | "GY" | +| HA | "HA" | +| HM | "HM" | +| VT | "VT" | +| HO | "HO" | +| HK | "HK" | +| HQ | "HQ" | +| HU | "HU" | +| IC | "IC" | +| IN | "IN" | +| ID | "ID" | +| IR | "IR" | +| IZ | "IZ" | +| EI | "EI" | +| IS | "IS" | +| IT | "IT" | +| JM | "JM" | +| JN | "JN" | +| JA | "JA" | +| DQ | "DQ" | +| JE | "JE" | +| JQ | "JQ" | +| JO | "JO" | +| KZ | "KZ" | +| KE | "KE" | +| KQ | "KQ" | +| KR | "KR" | +| KN | "KN" | +| KS | "KS" | +| KV | "KV" | +| KU | "KU" | +| KG | "KG" | +| LA | "LA" | +| LG | "LG" | +| LE | "LE" | +| LT | "LT" | +| LI | "LI" | +| LY | "LY" | +| LS | "LS" | +| LH | "LH" | +| LU | "LU" | +| MC | "MC" | +| MK | "MK" | +| MA | "MA" | +| MI | "MI" | +| MY | "MY" | +| MV | "MV" | +| ML | "ML" | +| MT | "MT" | +| IM | "IM" | +| RM | "RM" | +| MR | "MR" | +| MP | "MP" | +| MX | "MX" | +| MQ | "MQ" | +| MD | "MD" | +| MN | "MN" | +| MG | "MG" | +| MJ | "MJ" | +| MH | "MH" | +| MO | "MO" | +| MZ | "MZ" | +| WA | "WA" | +| NR | "NR" | +| BQ | "BQ" | +| NP | "NP" | +| NL | "NL" | +| NC | "NC" | +| NZ | "NZ" | +| NU | "NU" | +| NG | "NG" | +| NI | "NI" | +| NE | "NE" | +| NF | "NF" | +| CQ | "CQ" | +| NO | "NO" | +| MU | "MU" | +| OC | "OC" | +| PK | "PK" | +| PS | "PS" | +| LQ | "LQ" | +| PM | "PM" | +| PP | "PP" | +| PF | "PF" | +| PA | "PA" | +| PE | "PE" | +| RP | "RP" | +| PC | "PC" | +| PL | "PL" | +| PO | "PO" | +| RQ | "RQ" | +| QA | "QA" | +| RO | "RO" | +| RS | "RS" | +| RW | "RW" | +| TB | "TB" | +| RN | "RN" | +| WS | "WS" | +| SM | "SM" | +| TP | "TP" | +| SA | "SA" | +| SG | "SG" | +| RI | "RI" | +| SE | "SE" | +| SL | "SL" | +| SN | "SN" | +| NN | "NN" | +| LO | "LO" | +| SI | "SI" | +| BP | "BP" | +| SO | "SO" | +| SF | "SF" | +| SX | "SX" | +| SP | "SP" | +| PG | "PG" | +| CE | "CE" | +| SH | "SH" | +| SC | "SC" | +| ST | "ST" | +| SB | "SB" | +| VC | "VC" | +| SU | "SU" | +| NS | "NS" | +| SV | "SV" | +| WZ | "WZ" | +| SW | "SW" | +| SZ | "SZ" | +| SY | "SY" | +| TW | "TW" | +| TI | "TI" | +| TZ | "TZ" | +| TH | "TH" | +| TO | "TO" | +| TL | "TL" | +| TN | "TN" | +| TD | "TD" | +| TS | "TS" | +| TU | "TU" | +| TX | "TX" | +| TK | "TK" | +| TV | "TV" | +| UG | "UG" | +| UP | "UP" | +| AE | "AE" | +| UK | "UK" | +| UY | "UY" | +| UZ | "UZ" | +| NH | "NH" | +| VE | "VE" | +| VM | "VM" | +| VQ | "VQ" | +| WQ | "WQ" | +| WF | "WF" | +| WI | "WI" | +| YM | "YM" | +| ZA | "ZA" | +| ZI | "ZI" | + + + +## Enum: EntityTypeEnum + +| Name | Value | +|---- | -----| +| CORPORATION | "Corporation" | +| DISREGARDED_ENTITY | "DisregardedEntity" | +| PARTNERSHIP | "Partnership" | +| SIMPLE_TRUST | "SimpleTrust" | +| GRANTOR_TRUST | "GrantorTrust" | +| COMPLEX_TRUST | "ComplexTrust" | +| ESTATE | "Estate" | +| FOREIGN_GOVERNMENT_CONTROLLED_ENTITY | "ForeignGovernmentControlledEntity" | +| CENTRAL_BANK_OF_ISSUE | "CentralBankOfIssue" | +| TAX_EXEMPT_ORGANIZATION | "TaxExemptOrganization" | +| PRIVATE_FOUNDATION | "PrivateFoundation" | +| INTERNATIONAL_ORGANIZATION | "InternationalOrganization" | +| FOREIGN_GOVERNMENT_CONTROLLED_INTEGRAL_PART | "ForeignGovernmentControlledIntegralPart" | + + + +## Enum: FatcaStatusEnum + +| Name | Value | +|---- | -----| +| NONPARTICIPATING_FFI | "NonparticipatingFFI" | +| PARTICIPATING_FFI | "ParticipatingFFI" | +| REPORTING_MODEL1_FFI | "ReportingModel1FFI" | +| REPORTING_MODEL2_FFI | "ReportingModel2FFI" | +| REGISTERED_DEEMED_COMPLIANT_FFI | "RegisteredDeemedCompliantFFI" | +| SPONSORED_FFI_WITHOUT_GIIN | "SponsoredFFIWithoutGIIN" | +| CERTIFIED_DEEMED_COMPLIANT_NONREGISTERING_LOCAL_BANK | "CertifiedDeemedCompliantNonregisteringLocalBank" | +| CERTIFIED_DEEMED_COMPLIANT_FFI_WITH_LOW_VALUE_ACCOUNTS | "CertifiedDeemedCompliantFFIWithLowValueAccounts" | +| CERTIFIED_DEEMED_COMPLIANT_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE | "CertifiedDeemedCompliantSponsoredCloselyHeldInvestmentVehicle" | +| CERTIFIED_DEEMED_COMPLIANT_LIMITED_LIFE_DEBT_INVESTMENT_ENTITY | "CertifiedDeemedCompliantLimitedLifeDebtInvestmentEntity" | +| CERTAIN_INVESTMENT_ENTITIES_WITHOUT_FINANCIAL_ACCOUNTS | "CertainInvestmentEntitiesWithoutFinancialAccounts" | +| OWNER_DOCUMENTED_FFI | "OwnerDocumentedFFI" | +| RESTRICTED_DISTRIBUTOR | "RestrictedDistributor" | +| NONREPORTING_IGAFFI | "NonreportingIGAFFI" | +| FOREIGN_GOVERNMENT_OR_US_POSSESSION_OR_FOREIGN_CENTRAL_BANK | "ForeignGovernmentOrUSPossessionOrForeignCentralBank" | +| INTERNATIONAL_ORGANIZATION | "InternationalOrganization" | +| EXEMPT_RETIREMENT_PLANS | "ExemptRetirementPlans" | +| ENTITY_WHOLLY_OWNED_BY_EXEMPT_BENEFICIAL_OWNERS | "EntityWhollyOwnedByExemptBeneficialOwners" | +| TERRITORY_FINANCIAL_INSTITUTION | "TerritoryFinancialInstitution" | +| NONFINANCIAL_GROUP_ENTITY | "NonfinancialGroupEntity" | +| EXCEPTED_NONFINANCIAL_START_UP_COMPANY | "ExceptedNonfinancialStartUpCompany" | +| EXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCY | "ExceptedNonfinancialEntityInLiquidationOrBankruptcy" | +| ORGANIZATION501C | "Organization501c" | +| NONPROFIT_ORGANIZATION | "NonprofitOrganization" | +| PUBLICLY_TRADED_NFFEOR_AFFILIATE_OF_PUBLICLY_TRADED_CORPORATION | "PubliclyTradedNFFEOrAffiliateOfPubliclyTradedCorporation" | +| EXCEPTED_TERRITORY_NFFE | "ExceptedTerritoryNFFE" | +| ACTIVE_NFFE | "ActiveNFFE" | +| PASSIVE_NFFE | "PassiveNFFE" | +| EXCEPTED_INTER_AFFILIATE_FFI | "ExceptedInterAffiliateFFI" | +| DIRECT_REPORTING_NFFE | "DirectReportingNFFE" | +| SPONSORED_DIRECT_REPORTING_NFFE | "SponsoredDirectReportingNFFE" | +| ACCOUNT_THAT_IS_NOT_FINANCIAL_ACCOUNT | "AccountThatIsNotFinancialAccount" | + + + +## Enum: ResidenceStateEnum + +| Name | Value | +|---- | -----| +| AA | "AA" | +| AE | "AE" | +| AK | "AK" | +| AL | "AL" | +| AP | "AP" | +| AR | "AR" | +| AS | "AS" | +| AZ | "AZ" | +| CA | "CA" | +| CO | "CO" | +| CT | "CT" | +| DC | "DC" | +| DE | "DE" | +| FL | "FL" | +| FM | "FM" | +| GA | "GA" | +| GU | "GU" | +| HI | "HI" | +| IA | "IA" | +| ID | "ID" | +| IL | "IL" | +| IN | "IN" | +| KS | "KS" | +| KY | "KY" | +| LA | "LA" | +| MA | "MA" | +| MD | "MD" | +| ME | "ME" | +| MH | "MH" | +| MI | "MI" | +| MN | "MN" | +| MO | "MO" | +| MP | "MP" | +| MS | "MS" | +| MT | "MT" | +| NC | "NC" | +| ND | "ND" | +| NE | "NE" | +| NH | "NH" | +| NJ | "NJ" | +| NM | "NM" | +| NV | "NV" | +| NY | "NY" | +| OH | "OH" | +| OK | "OK" | +| OR | "OR" | +| PA | "PA" | +| PR | "PR" | +| PW | "PW" | +| RI | "RI" | +| SC | "SC" | +| SD | "SD" | +| TN | "TN" | +| TX | "TX" | +| UT | "UT" | +| VA | "VA" | +| VI | "VI" | +| VT | "VT" | +| WA | "WA" | +| WI | "WI" | +| WV | "WV" | +| WY | "WY" | +| AB | "AB" | +| BC | "BC" | +| MB | "MB" | +| NB | "NB" | +| NL | "NL" | +| NS | "NS" | +| NT | "NT" | +| NU | "NU" | +| ON | "ON" | +| PE | "PE" | +| QC | "QC" | +| SK | "SK" | +| YT | "YT" | + + + +## Enum: ResidenceCountryEnum + +| Name | Value | +|---- | -----| +| US | "US" | +| AF | "AF" | +| AX | "AX" | +| AL | "AL" | +| AG | "AG" | +| AQ | "AQ" | +| AN | "AN" | +| AO | "AO" | +| AV | "AV" | +| AY | "AY" | +| AC | "AC" | +| AR | "AR" | +| AM | "AM" | +| AA | "AA" | +| AT | "AT" | +| AS | "AS" | +| AU | "AU" | +| AJ | "AJ" | +| BF | "BF" | +| BA | "BA" | +| FQ | "FQ" | +| BG | "BG" | +| BB | "BB" | +| BO | "BO" | +| BE | "BE" | +| BH | "BH" | +| BN | "BN" | +| BD | "BD" | +| BT | "BT" | +| BL | "BL" | +| BK | "BK" | +| BC | "BC" | +| BV | "BV" | +| BR | "BR" | +| IO | "IO" | +| VI | "VI" | +| BX | "BX" | +| BU | "BU" | +| UV | "UV" | +| BM | "BM" | +| BY | "BY" | +| CB | "CB" | +| CM | "CM" | +| CA | "CA" | +| CV | "CV" | +| CJ | "CJ" | +| CT | "CT" | +| CD | "CD" | +| CI | "CI" | +| CH | "CH" | +| KT | "KT" | +| IP | "IP" | +| CK | "CK" | +| CO | "CO" | +| CN | "CN" | +| CF | "CF" | +| CG | "CG" | +| CW | "CW" | +| CR | "CR" | +| CS | "CS" | +| IV | "IV" | +| HR | "HR" | +| CU | "CU" | +| UC | "UC" | +| CY | "CY" | +| EZ | "EZ" | +| DA | "DA" | +| DX | "DX" | +| DJ | "DJ" | +| DO | "DO" | +| DR | "DR" | +| TT | "TT" | +| EC | "EC" | +| EG | "EG" | +| ES | "ES" | +| EK | "EK" | +| ER | "ER" | +| EN | "EN" | +| ET | "ET" | +| FK | "FK" | +| FO | "FO" | +| FM | "FM" | +| FJ | "FJ" | +| FI | "FI" | +| FR | "FR" | +| FP | "FP" | +| FS | "FS" | +| GB | "GB" | +| GA | "GA" | +| GG | "GG" | +| GM | "GM" | +| GH | "GH" | +| GI | "GI" | +| GR | "GR" | +| GL | "GL" | +| GJ | "GJ" | +| GQ | "GQ" | +| GT | "GT" | +| GK | "GK" | +| GV | "GV" | +| PU | "PU" | +| GY | "GY" | +| HA | "HA" | +| HM | "HM" | +| VT | "VT" | +| HO | "HO" | +| HK | "HK" | +| HQ | "HQ" | +| HU | "HU" | +| IC | "IC" | +| IN | "IN" | +| ID | "ID" | +| IR | "IR" | +| IZ | "IZ" | +| EI | "EI" | +| IS | "IS" | +| IT | "IT" | +| JM | "JM" | +| JN | "JN" | +| JA | "JA" | +| DQ | "DQ" | +| JE | "JE" | +| JQ | "JQ" | +| JO | "JO" | +| KZ | "KZ" | +| KE | "KE" | +| KQ | "KQ" | +| KR | "KR" | +| KN | "KN" | +| KS | "KS" | +| KV | "KV" | +| KU | "KU" | +| KG | "KG" | +| LA | "LA" | +| LG | "LG" | +| LE | "LE" | +| LT | "LT" | +| LI | "LI" | +| LY | "LY" | +| LS | "LS" | +| LH | "LH" | +| LU | "LU" | +| MC | "MC" | +| MK | "MK" | +| MA | "MA" | +| MI | "MI" | +| MY | "MY" | +| MV | "MV" | +| ML | "ML" | +| MT | "MT" | +| IM | "IM" | +| RM | "RM" | +| MR | "MR" | +| MP | "MP" | +| MX | "MX" | +| MQ | "MQ" | +| MD | "MD" | +| MN | "MN" | +| MG | "MG" | +| MJ | "MJ" | +| MH | "MH" | +| MO | "MO" | +| MZ | "MZ" | +| WA | "WA" | +| NR | "NR" | +| BQ | "BQ" | +| NP | "NP" | +| NL | "NL" | +| NC | "NC" | +| NZ | "NZ" | +| NU | "NU" | +| NG | "NG" | +| NI | "NI" | +| NE | "NE" | +| NF | "NF" | +| CQ | "CQ" | +| NO | "NO" | +| MU | "MU" | +| OC | "OC" | +| PK | "PK" | +| PS | "PS" | +| LQ | "LQ" | +| PM | "PM" | +| PP | "PP" | +| PF | "PF" | +| PA | "PA" | +| PE | "PE" | +| RP | "RP" | +| PC | "PC" | +| PL | "PL" | +| PO | "PO" | +| RQ | "RQ" | +| QA | "QA" | +| RO | "RO" | +| RS | "RS" | +| RW | "RW" | +| TB | "TB" | +| RN | "RN" | +| WS | "WS" | +| SM | "SM" | +| TP | "TP" | +| SA | "SA" | +| SG | "SG" | +| RI | "RI" | +| SE | "SE" | +| SL | "SL" | +| SN | "SN" | +| NN | "NN" | +| LO | "LO" | +| SI | "SI" | +| BP | "BP" | +| SO | "SO" | +| SF | "SF" | +| SX | "SX" | +| SP | "SP" | +| PG | "PG" | +| CE | "CE" | +| SH | "SH" | +| SC | "SC" | +| ST | "ST" | +| SB | "SB" | +| VC | "VC" | +| SU | "SU" | +| NS | "NS" | +| SV | "SV" | +| WZ | "WZ" | +| SW | "SW" | +| SZ | "SZ" | +| SY | "SY" | +| TW | "TW" | +| TI | "TI" | +| TZ | "TZ" | +| TH | "TH" | +| TO | "TO" | +| TL | "TL" | +| TN | "TN" | +| TD | "TD" | +| TS | "TS" | +| TU | "TU" | +| TX | "TX" | +| TK | "TK" | +| TV | "TV" | +| UG | "UG" | +| UP | "UP" | +| AE | "AE" | +| UK | "UK" | +| UY | "UY" | +| UZ | "UZ" | +| NH | "NH" | +| VE | "VE" | +| VM | "VM" | +| VQ | "VQ" | +| WQ | "WQ" | +| WF | "WF" | +| WI | "WI" | +| YM | "YM" | +| ZA | "ZA" | +| ZI | "ZI" | + + + +## Enum: MailingStateEnum + +| Name | Value | +|---- | -----| +| AA | "AA" | +| AE | "AE" | +| AK | "AK" | +| AL | "AL" | +| AP | "AP" | +| AR | "AR" | +| AS | "AS" | +| AZ | "AZ" | +| CA | "CA" | +| CO | "CO" | +| CT | "CT" | +| DC | "DC" | +| DE | "DE" | +| FL | "FL" | +| FM | "FM" | +| GA | "GA" | +| GU | "GU" | +| HI | "HI" | +| IA | "IA" | +| ID | "ID" | +| IL | "IL" | +| IN | "IN" | +| KS | "KS" | +| KY | "KY" | +| LA | "LA" | +| MA | "MA" | +| MD | "MD" | +| ME | "ME" | +| MH | "MH" | +| MI | "MI" | +| MN | "MN" | +| MO | "MO" | +| MP | "MP" | +| MS | "MS" | +| MT | "MT" | +| NC | "NC" | +| ND | "ND" | +| NE | "NE" | +| NH | "NH" | +| NJ | "NJ" | +| NM | "NM" | +| NV | "NV" | +| NY | "NY" | +| OH | "OH" | +| OK | "OK" | +| OR | "OR" | +| PA | "PA" | +| PR | "PR" | +| PW | "PW" | +| RI | "RI" | +| SC | "SC" | +| SD | "SD" | +| TN | "TN" | +| TX | "TX" | +| UT | "UT" | +| VA | "VA" | +| VI | "VI" | +| VT | "VT" | +| WA | "WA" | +| WI | "WI" | +| WV | "WV" | +| WY | "WY" | +| AB | "AB" | +| BC | "BC" | +| MB | "MB" | +| NB | "NB" | +| NL | "NL" | +| NS | "NS" | +| NT | "NT" | +| NU | "NU" | +| ON | "ON" | +| PE | "PE" | +| QC | "QC" | +| SK | "SK" | +| YT | "YT" | + + + +## Enum: MailingCountryEnum + +| Name | Value | +|---- | -----| +| US | "US" | +| AF | "AF" | +| AX | "AX" | +| AL | "AL" | +| AG | "AG" | +| AQ | "AQ" | +| AN | "AN" | +| AO | "AO" | +| AV | "AV" | +| AY | "AY" | +| AC | "AC" | +| AR | "AR" | +| AM | "AM" | +| AA | "AA" | +| AT | "AT" | +| AS | "AS" | +| AU | "AU" | +| AJ | "AJ" | +| BF | "BF" | +| BA | "BA" | +| FQ | "FQ" | +| BG | "BG" | +| BB | "BB" | +| BO | "BO" | +| BE | "BE" | +| BH | "BH" | +| BN | "BN" | +| BD | "BD" | +| BT | "BT" | +| BL | "BL" | +| BK | "BK" | +| BC | "BC" | +| BV | "BV" | +| BR | "BR" | +| IO | "IO" | +| VI | "VI" | +| BX | "BX" | +| BU | "BU" | +| UV | "UV" | +| BM | "BM" | +| BY | "BY" | +| CB | "CB" | +| CM | "CM" | +| CA | "CA" | +| CV | "CV" | +| CJ | "CJ" | +| CT | "CT" | +| CD | "CD" | +| CI | "CI" | +| CH | "CH" | +| KT | "KT" | +| IP | "IP" | +| CK | "CK" | +| CO | "CO" | +| CN | "CN" | +| CF | "CF" | +| CG | "CG" | +| CW | "CW" | +| CR | "CR" | +| CS | "CS" | +| IV | "IV" | +| HR | "HR" | +| CU | "CU" | +| UC | "UC" | +| CY | "CY" | +| EZ | "EZ" | +| DA | "DA" | +| DX | "DX" | +| DJ | "DJ" | +| DO | "DO" | +| DR | "DR" | +| TT | "TT" | +| EC | "EC" | +| EG | "EG" | +| ES | "ES" | +| EK | "EK" | +| ER | "ER" | +| EN | "EN" | +| ET | "ET" | +| FK | "FK" | +| FO | "FO" | +| FM | "FM" | +| FJ | "FJ" | +| FI | "FI" | +| FR | "FR" | +| FP | "FP" | +| FS | "FS" | +| GB | "GB" | +| GA | "GA" | +| GG | "GG" | +| GM | "GM" | +| GH | "GH" | +| GI | "GI" | +| GR | "GR" | +| GL | "GL" | +| GJ | "GJ" | +| GQ | "GQ" | +| GT | "GT" | +| GK | "GK" | +| GV | "GV" | +| PU | "PU" | +| GY | "GY" | +| HA | "HA" | +| HM | "HM" | +| VT | "VT" | +| HO | "HO" | +| HK | "HK" | +| HQ | "HQ" | +| HU | "HU" | +| IC | "IC" | +| IN | "IN" | +| ID | "ID" | +| IR | "IR" | +| IZ | "IZ" | +| EI | "EI" | +| IS | "IS" | +| IT | "IT" | +| JM | "JM" | +| JN | "JN" | +| JA | "JA" | +| DQ | "DQ" | +| JE | "JE" | +| JQ | "JQ" | +| JO | "JO" | +| KZ | "KZ" | +| KE | "KE" | +| KQ | "KQ" | +| KR | "KR" | +| KN | "KN" | +| KS | "KS" | +| KV | "KV" | +| KU | "KU" | +| KG | "KG" | +| LA | "LA" | +| LG | "LG" | +| LE | "LE" | +| LT | "LT" | +| LI | "LI" | +| LY | "LY" | +| LS | "LS" | +| LH | "LH" | +| LU | "LU" | +| MC | "MC" | +| MK | "MK" | +| MA | "MA" | +| MI | "MI" | +| MY | "MY" | +| MV | "MV" | +| ML | "ML" | +| MT | "MT" | +| IM | "IM" | +| RM | "RM" | +| MR | "MR" | +| MP | "MP" | +| MX | "MX" | +| MQ | "MQ" | +| MD | "MD" | +| MN | "MN" | +| MG | "MG" | +| MJ | "MJ" | +| MH | "MH" | +| MO | "MO" | +| MZ | "MZ" | +| WA | "WA" | +| NR | "NR" | +| BQ | "BQ" | +| NP | "NP" | +| NL | "NL" | +| NC | "NC" | +| NZ | "NZ" | +| NU | "NU" | +| NG | "NG" | +| NI | "NI" | +| NE | "NE" | +| NF | "NF" | +| CQ | "CQ" | +| NO | "NO" | +| MU | "MU" | +| OC | "OC" | +| PK | "PK" | +| PS | "PS" | +| LQ | "LQ" | +| PM | "PM" | +| PP | "PP" | +| PF | "PF" | +| PA | "PA" | +| PE | "PE" | +| RP | "RP" | +| PC | "PC" | +| PL | "PL" | +| PO | "PO" | +| RQ | "RQ" | +| QA | "QA" | +| RO | "RO" | +| RS | "RS" | +| RW | "RW" | +| TB | "TB" | +| RN | "RN" | +| WS | "WS" | +| SM | "SM" | +| TP | "TP" | +| SA | "SA" | +| SG | "SG" | +| RI | "RI" | +| SE | "SE" | +| SL | "SL" | +| SN | "SN" | +| NN | "NN" | +| LO | "LO" | +| SI | "SI" | +| BP | "BP" | +| SO | "SO" | +| SF | "SF" | +| SX | "SX" | +| SP | "SP" | +| PG | "PG" | +| CE | "CE" | +| SH | "SH" | +| SC | "SC" | +| ST | "ST" | +| SB | "SB" | +| VC | "VC" | +| SU | "SU" | +| NS | "NS" | +| SV | "SV" | +| WZ | "WZ" | +| SW | "SW" | +| SZ | "SZ" | +| SY | "SY" | +| TW | "TW" | +| TI | "TI" | +| TZ | "TZ" | +| TH | "TH" | +| TO | "TO" | +| TL | "TL" | +| TN | "TN" | +| TD | "TD" | +| TS | "TS" | +| TU | "TU" | +| TX | "TX" | +| TK | "TK" | +| TV | "TV" | +| UG | "UG" | +| UP | "UP" | +| AE | "AE" | +| UK | "UK" | +| UY | "UY" | +| UZ | "UZ" | +| NH | "NH" | +| VE | "VE" | +| VM | "VM" | +| VQ | "VQ" | +| WQ | "WQ" | +| WF | "WF" | +| WI | "WI" | +| YM | "YM" | +| ZA | "ZA" | +| ZI | "ZI" | + + + +## Enum: DisregardedEntityFatcaStatusEnum + +| Name | Value | +|---- | -----| +| BRANCH_TREATED_AS_NONPARTICIPATING_FFI | "BranchTreatedAsNonparticipatingFFI" | +| US_BRANCH | "USBranch" | +| PARTICIPATING_FFI | "ParticipatingFFI" | +| REPORTING_MODEL1_FFI | "ReportingModel1FFI" | +| REPORTING_MODEL2_FFI | "ReportingModel2FFI" | + + + +## Enum: DisregardedStateEnum + +| Name | Value | +|---- | -----| +| AA | "AA" | +| AE | "AE" | +| AK | "AK" | +| AL | "AL" | +| AP | "AP" | +| AR | "AR" | +| AS | "AS" | +| AZ | "AZ" | +| CA | "CA" | +| CO | "CO" | +| CT | "CT" | +| DC | "DC" | +| DE | "DE" | +| FL | "FL" | +| FM | "FM" | +| GA | "GA" | +| GU | "GU" | +| HI | "HI" | +| IA | "IA" | +| ID | "ID" | +| IL | "IL" | +| IN | "IN" | +| KS | "KS" | +| KY | "KY" | +| LA | "LA" | +| MA | "MA" | +| MD | "MD" | +| ME | "ME" | +| MH | "MH" | +| MI | "MI" | +| MN | "MN" | +| MO | "MO" | +| MP | "MP" | +| MS | "MS" | +| MT | "MT" | +| NC | "NC" | +| ND | "ND" | +| NE | "NE" | +| NH | "NH" | +| NJ | "NJ" | +| NM | "NM" | +| NV | "NV" | +| NY | "NY" | +| OH | "OH" | +| OK | "OK" | +| OR | "OR" | +| PA | "PA" | +| PR | "PR" | +| PW | "PW" | +| RI | "RI" | +| SC | "SC" | +| SD | "SD" | +| TN | "TN" | +| TX | "TX" | +| UT | "UT" | +| VA | "VA" | +| VI | "VI" | +| VT | "VT" | +| WA | "WA" | +| WI | "WI" | +| WV | "WV" | +| WY | "WY" | + + + +## Enum: IgaModelEnum + +| Name | Value | +|---- | -----| +| MODEL1_IGA | "Model1IGA" | +| MODEL2_IGA | "Model2IGA" | + + + +## Enum: TreatyCountryEnum + +| Name | Value | +|---- | -----| +| US | "US" | +| AF | "AF" | +| AX | "AX" | +| AL | "AL" | +| AG | "AG" | +| AQ | "AQ" | +| AN | "AN" | +| AO | "AO" | +| AV | "AV" | +| AY | "AY" | +| AC | "AC" | +| AR | "AR" | +| AM | "AM" | +| AA | "AA" | +| AT | "AT" | +| AS | "AS" | +| AU | "AU" | +| AJ | "AJ" | +| BF | "BF" | +| BA | "BA" | +| FQ | "FQ" | +| BG | "BG" | +| BB | "BB" | +| BO | "BO" | +| BE | "BE" | +| BH | "BH" | +| BN | "BN" | +| BD | "BD" | +| BT | "BT" | +| BL | "BL" | +| BK | "BK" | +| BC | "BC" | +| BV | "BV" | +| BR | "BR" | +| IO | "IO" | +| VI | "VI" | +| BX | "BX" | +| BU | "BU" | +| UV | "UV" | +| BM | "BM" | +| BY | "BY" | +| CB | "CB" | +| CM | "CM" | +| CA | "CA" | +| CV | "CV" | +| CJ | "CJ" | +| CT | "CT" | +| CD | "CD" | +| CI | "CI" | +| CH | "CH" | +| KT | "KT" | +| IP | "IP" | +| CK | "CK" | +| CO | "CO" | +| CN | "CN" | +| CF | "CF" | +| CG | "CG" | +| CW | "CW" | +| CR | "CR" | +| CS | "CS" | +| IV | "IV" | +| HR | "HR" | +| CU | "CU" | +| UC | "UC" | +| CY | "CY" | +| EZ | "EZ" | +| DA | "DA" | +| DX | "DX" | +| DJ | "DJ" | +| DO | "DO" | +| DR | "DR" | +| TT | "TT" | +| EC | "EC" | +| EG | "EG" | +| ES | "ES" | +| EK | "EK" | +| ER | "ER" | +| EN | "EN" | +| ET | "ET" | +| FK | "FK" | +| FO | "FO" | +| FM | "FM" | +| FJ | "FJ" | +| FI | "FI" | +| FR | "FR" | +| FP | "FP" | +| FS | "FS" | +| GB | "GB" | +| GA | "GA" | +| GG | "GG" | +| GM | "GM" | +| GH | "GH" | +| GI | "GI" | +| GR | "GR" | +| GL | "GL" | +| GJ | "GJ" | +| GQ | "GQ" | +| GT | "GT" | +| GK | "GK" | +| GV | "GV" | +| PU | "PU" | +| GY | "GY" | +| HA | "HA" | +| HM | "HM" | +| VT | "VT" | +| HO | "HO" | +| HK | "HK" | +| HQ | "HQ" | +| HU | "HU" | +| IC | "IC" | +| IN | "IN" | +| ID | "ID" | +| IR | "IR" | +| IZ | "IZ" | +| EI | "EI" | +| IS | "IS" | +| IT | "IT" | +| JM | "JM" | +| JN | "JN" | +| JA | "JA" | +| DQ | "DQ" | +| JE | "JE" | +| JQ | "JQ" | +| JO | "JO" | +| KZ | "KZ" | +| KE | "KE" | +| KQ | "KQ" | +| KR | "KR" | +| KN | "KN" | +| KS | "KS" | +| KV | "KV" | +| KU | "KU" | +| KG | "KG" | +| LA | "LA" | +| LG | "LG" | +| LE | "LE" | +| LT | "LT" | +| LI | "LI" | +| LY | "LY" | +| LS | "LS" | +| LH | "LH" | +| LU | "LU" | +| MC | "MC" | +| MK | "MK" | +| MA | "MA" | +| MI | "MI" | +| MY | "MY" | +| MV | "MV" | +| ML | "ML" | +| MT | "MT" | +| IM | "IM" | +| RM | "RM" | +| MR | "MR" | +| MP | "MP" | +| MX | "MX" | +| MQ | "MQ" | +| MD | "MD" | +| MN | "MN" | +| MG | "MG" | +| MJ | "MJ" | +| MH | "MH" | +| MO | "MO" | +| MZ | "MZ" | +| WA | "WA" | +| NR | "NR" | +| BQ | "BQ" | +| NP | "NP" | +| NL | "NL" | +| NC | "NC" | +| NZ | "NZ" | +| NU | "NU" | +| NG | "NG" | +| NI | "NI" | +| NE | "NE" | +| NF | "NF" | +| CQ | "CQ" | +| NO | "NO" | +| MU | "MU" | +| OC | "OC" | +| PK | "PK" | +| PS | "PS" | +| LQ | "LQ" | +| PM | "PM" | +| PP | "PP" | +| PF | "PF" | +| PA | "PA" | +| PE | "PE" | +| RP | "RP" | +| PC | "PC" | +| PL | "PL" | +| PO | "PO" | +| RQ | "RQ" | +| QA | "QA" | +| RO | "RO" | +| RS | "RS" | +| RW | "RW" | +| TB | "TB" | +| RN | "RN" | +| WS | "WS" | +| SM | "SM" | +| TP | "TP" | +| SA | "SA" | +| SG | "SG" | +| RI | "RI" | +| SE | "SE" | +| SL | "SL" | +| SN | "SN" | +| NN | "NN" | +| LO | "LO" | +| SI | "SI" | +| BP | "BP" | +| SO | "SO" | +| SF | "SF" | +| SX | "SX" | +| SP | "SP" | +| PG | "PG" | +| CE | "CE" | +| SH | "SH" | +| SC | "SC" | +| ST | "ST" | +| SB | "SB" | +| VC | "VC" | +| SU | "SU" | +| NS | "NS" | +| SV | "SV" | +| WZ | "WZ" | +| SW | "SW" | +| SZ | "SZ" | +| SY | "SY" | +| TW | "TW" | +| TI | "TI" | +| TZ | "TZ" | +| TH | "TH" | +| TO | "TO" | +| TL | "TL" | +| TN | "TN" | +| TD | "TD" | +| TS | "TS" | +| TU | "TU" | +| TX | "TX" | +| TK | "TK" | +| TV | "TV" | +| UG | "UG" | +| UP | "UP" | +| AE | "AE" | +| UK | "UK" | +| UY | "UY" | +| UZ | "UZ" | +| NH | "NH" | +| VE | "VE" | +| VM | "VM" | +| VQ | "VQ" | +| WQ | "WQ" | +| WF | "WF" | +| WI | "WI" | +| YM | "YM" | +| ZA | "ZA" | +| ZI | "ZI" | + + + +## Enum: BenefitLimitationEnum + +| Name | Value | +|---- | -----| +| GOVERNMENT | "Government" | +| TAX_EXEMPT_PENSION_TRUST_OR_PENSION_FUND | "TaxExemptPensionTrustOrPensionFund" | +| OTHER_TAX_EXEMPT_ORGANIZATION | "OtherTaxExemptOrganization" | +| PUBLICLY_TRADED_CORPORATION | "PubliclyTradedCorporation" | +| SUBSIDIARY_OF_PUBLICLY_TRADED_CORPORATION | "SubsidiaryOfPubliclyTradedCorporation" | +| COMPANY_THAT_MEETS_OWNERSHIP_AND_BASE_EROSION_TEST | "CompanyThatMeetsOwnershipAndBaseErosionTest" | +| COMPANY_THAT_MEETS_DERIVATIVE_BENEFITS_TEST | "CompanyThatMeetsDerivativeBenefitsTest" | +| COMPANY_WITH_ITEM_OF_INCOME_THAT_MEETS_ACTIVE_TRADE_OR_BUSINESS_TEST | "CompanyWithItemOfIncomeThatMeetsActiveTradeOrBusinessTest" | +| FAVORABLE_DISCRETIONARY_DETERMINATION_BY_US_COMPETENT_AUTHORITY_RECEIVED | "FavorableDiscretionaryDeterminationByUSCompetentAuthorityReceived" | +| OTHER | "Other" | +| NO_LOB_ARTICLE_IN_TREATY | "NoLOBArticleInTreaty" | + + + +## Enum: WithholdingRateEnum + +| Name | Value | +|---- | -----| +| _0 | "0" | +| _0_0 | "0.0" | +| _0_00 | "0.00" | +| _5 | "5" | +| _5_5 | "5.5" | +| _10 | "10" | +| _12_50 | "12.50" | +| _15 | "15" | +| _20 | "20" | +| _25 | "25" | +| _30 | "30" | + + + ## Enum: MaritalStatusEnum | Name | Value | diff --git a/docs/A1099/V2/Forms1099Api.md b/docs/A1099/V2/Forms1099Api.md index 0bda689..12be7d8 100644 --- a/docs/A1099/V2/Forms1099Api.md +++ b/docs/A1099/V2/Forms1099Api.md @@ -52,7 +52,7 @@ public class Example { Forms1099Api apiInstance = new Forms1099Api(apiClient); String avalaraVersion = "2.0.0"; // String | API version Boolean dryRun = false; // Boolean | defaults to false. If true, it will NOT change the DB. It will just return a report of what would've have been changed in the DB - String xCorrelationId = "eec0b095-bfa8-4786-bbad-3f20a4b61ac2"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "2d9b6e7b-79bb-4d14-9699-4638bb6151d9"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . Form1099ListRequest form1099ListRequest = new Form1099ListRequest(); // Form1099ListRequest | try { @@ -141,7 +141,7 @@ public class Example { Forms1099Api apiInstance = new Forms1099Api(apiClient); String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "ea80e3d4-6198-4297-9fff-4b12b5d270a0"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "5274903f-4f84-4aba-9dcf-408ca56e00ea"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . Get1099Form200Response get1099Form200Response = new Get1099Form200Response(); // Get1099Form200Response | try { @@ -229,7 +229,7 @@ public class Example { Forms1099Api apiInstance = new Forms1099Api(apiClient); String id = "id_example"; // String | The unique identifier of the desired form to delete. String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "6f61d545-12cb-445a-b60c-bd21c3f78ae3"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "f59c9692-f2fb-4dbe-8cba-98633c4bfb3b"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { apiInstance.delete1099Form(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -317,7 +317,7 @@ public class Example { Forms1099Api apiInstance = new Forms1099Api(apiClient); String id = "id_example"; // String | String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "3dda6df9-8f00-4ac0-8eab-0e56263c2895"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "73429041-37dd-428a-8fd5-94f9bfdc849d"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { Get1099Form200Response result = apiInstance.get1099Form(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -406,7 +406,7 @@ public class Example { String id = "id_example"; // String | The ID of the form String avalaraVersion = "2.0.0"; // String | API version Boolean markEdelivered = true; // Boolean | Optional boolean that if set indicates that the form should be marked as having been successfully edelivered - String xCorrelationId = "83471033-6587-4425-a03e-1057de8d14cf"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "880a787b-1d92-485f-a3db-b5277d3d0ba1"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { File result = apiInstance.get1099FormPdf(id, avalaraVersion, markEdelivered, xCorrelationId, xAvalaraClient); @@ -500,7 +500,7 @@ public class Example { String $orderBy = "$orderBy_example"; // String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. Boolean count = true; // Boolean | If true, return the global count of elements in the collection. Boolean countOnly = true; // Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true. - String xCorrelationId = "9cd2b713-72ed-419c-8c1f-4aeef9f6b0d4"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "612ac19d-6b12-4fe1-b92b-61e73b3b5d54"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { PaginatedQueryResultModelForm1099Base result = apiInstance.list1099Forms(avalaraVersion, $filter, $top, $skip, $orderBy, count, countOnly, xCorrelationId, xAvalaraClient); @@ -593,7 +593,7 @@ public class Example { Forms1099Api apiInstance = new Forms1099Api(apiClient); String id = "id_example"; // String | String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "b0bb9771-ffdf-4884-bac3-7cf00bf7c745"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "5717cd04-c60c-4603-9ede-aba2bec55e19"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . Get1099Form200Response get1099Form200Response = new Get1099Form200Response(); // Get1099Form200Response | try { diff --git a/docs/A1099/V2/FormsW9Api.md b/docs/A1099/V2/FormsW9Api.md index 686bf99..951d26c 100644 --- a/docs/A1099/V2/FormsW9Api.md +++ b/docs/A1099/V2/FormsW9Api.md @@ -8,6 +8,7 @@ Method | HTTP request | Description [**createW9Form**](FormsW9Api.md#createW9Form) | **POST** /w9/forms | Create a W9/W4/W8 form [**deleteW9Form**](FormsW9Api.md#deleteW9Form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form [**getW9Form**](FormsW9Api.md#getW9Form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form +[**getW9FormPdf**](FormsW9Api.md#getW9FormPdf) | **GET** /w9/forms/{id}/pdf | Download the PDF for a W9/W4/W8 form. [**listW9Forms**](FormsW9Api.md#listW9Forms) | **GET** /w9/forms | List W9/W4/W8 forms [**sendW9FormEmail**](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 [**updateW9Form**](FormsW9Api.md#updateW9Form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form @@ -52,7 +53,7 @@ public class Example { FormsW9Api apiInstance = new FormsW9Api(apiClient); String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "0ab9baaf-56ae-484d-a812-1586d6141797"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "fa427ec8-fbb3-4e25-8c7e-2f81d68241ec"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . CreateAndSendW9FormEmailRequest createAndSendW9FormEmailRequest = new CreateAndSendW9FormEmailRequest(); // CreateAndSendW9FormEmailRequest | Form to be created try { @@ -138,7 +139,7 @@ public class Example { FormsW9Api apiInstance = new FormsW9Api(apiClient); String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "d1c7d02a-c0be-4a64-9fbb-0b4aed2f526c"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "6bde16cf-bc27-448b-8abd-a3461599deff"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . CreateW9FormRequest createW9FormRequest = new CreateW9FormRequest(); // CreateW9FormRequest | Form to be created try { @@ -225,7 +226,7 @@ public class Example { FormsW9Api apiInstance = new FormsW9Api(apiClient); String id = "id_example"; // String | ID of the form to delete String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "5c349318-0f66-4478-bcc0-ce6af3c9f485"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "4bc1a0f7-f202-4e27-ba6d-37645f4a839e"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { apiInstance.deleteW9Form(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -310,7 +311,7 @@ public class Example { FormsW9Api apiInstance = new FormsW9Api(apiClient); String id = "id_example"; // String | ID of the form String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "f39583e2-33c6-460f-aed2-66bc23ef3b6a"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "7dd6cb2c-d9ed-4fb7-8f97-67d35d09e59e"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { CreateW9Form201Response result = apiInstance.getW9Form(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -358,6 +359,92 @@ Name | Type | Description | Notes | **404** | W9/W4/W8 form not found | - | +## getW9FormPdf + +> getW9FormPdf(id, avalaraVersion, xCorrelationId, xAvalaraClient) + +Download the PDF for a W9/W4/W8 form. + +Returns the PDF file for a W9/W4/W8 form. + +### Example + +```java +// Import classes: +import Avalara.SDK.ApiClient; +import Avalara.SDK.ApiException; +import Avalara.SDK.Configuration; +import Avalara.SDK.auth.*; +import Avalara.SDK.models.*; +import Avalara.SDK.api.A1099.V2.FormsW9Api; + +public class Example { + public static void main(String[] args) { + Configuration configuration = new Configuration(); + configuration.setAppName("Test"); + configuration.setAppVersion("1.0"); + configuration.setMachineName("LocalBox"); + configuration.setTimeout(5000); + configuration.setEnvironment(AvaTaxEnvironment.Sandbox); + // Configure HTTP basic authorization + configuration.setUsername("YOUR USERNAME"); + configuration.setPassword("YOUR PASSWORD"); + // Configure OAuth2 access token for authorization + configuration.setBearerToken("YOUR ACCESS TOKEN"); + + ApiClient apiClient = new ApiClient(configuration); + + FormsW9Api apiInstance = new FormsW9Api(apiClient); + String id = "id_example"; // String | Id of the form + String avalaraVersion = "2.0.0"; // String | API version + String xCorrelationId = "783194b6-5fc6-41c5-a5b4-1b02018e09dd"; // String | Unique correlation Id in a GUID format + String xAvalaraClient = "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/) . + try { + apiInstance.getW9FormPdf(id, avalaraVersion, xCorrelationId, xAvalaraClient); + } catch (ApiException e) { + System.err.println("Exception when calling FormsW9Api#getW9FormPdf"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Id of the form | + **avalaraVersion** | **String**| API version | + **xCorrelationId** | **String**| Unique correlation Id in a GUID format | [optional] + **xAvalaraClient** | **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 + +null (empty response body) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/pdf, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | PDF stream | - | +| **400** | Bad request (e.g., invalid id) | - | +| **401** | Authentication failed | - | +| **404** | W9/W4/W8 form not found | - | + + ## listW9Forms > PaginatedQueryResultModelW9FormBaseResponse listW9Forms(avalaraVersion, $filter, $top, $skip, $orderBy, count, countOnly, xCorrelationId, xAvalaraClient) @@ -401,7 +488,7 @@ public class Example { String $orderBy = "$orderBy_example"; // String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. Boolean count = true; // Boolean | If true, return the global count of elements in the collection. Boolean countOnly = true; // Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true. - String xCorrelationId = "a60536fb-e758-4f92-a0cd-7d99addcc735"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "c1b56927-f8e5-4243-8fd5-b5d13f7c0c29"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { PaginatedQueryResultModelW9FormBaseResponse result = apiInstance.listW9Forms(avalaraVersion, $filter, $top, $skip, $orderBy, count, countOnly, xCorrelationId, xAvalaraClient); @@ -492,7 +579,7 @@ public class Example { FormsW9Api apiInstance = new FormsW9Api(apiClient); String id = "id_example"; // String | The ID of the W9/W4/W8 form. String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "8f2f717b-24cb-4bf1-9820-ded88ed93798"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "ef646026-89fe-420b-bea9-e29ec45d9557"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { CreateW9Form201Response result = apiInstance.sendW9FormEmail(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -580,7 +667,7 @@ public class Example { FormsW9Api apiInstance = new FormsW9Api(apiClient); String id = "id_example"; // String | ID of the form to update String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "8688fb2d-d79c-433a-9abf-4f96ea744f32"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "ac8f162c-fbee-4c4d-b9fa-986df02c90e3"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . CreateW9FormRequest createW9FormRequest = new CreateW9FormRequest(); // CreateW9FormRequest | Form to be updated try { @@ -669,7 +756,7 @@ public class Example { FormsW9Api apiInstance = new FormsW9Api(apiClient); String id = "id_example"; // String | Id of the form String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "13008974-9cbc-417c-a3d1-7779277a2077"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "c332bc05-2179-4a35-bd1a-1d01a3d03e36"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . File _file = new File("/path/to/file"); // File | try { diff --git a/docs/A1099/V2/Issuers1099Api.md b/docs/A1099/V2/Issuers1099Api.md index 41bf6c7..55a73b8 100644 --- a/docs/A1099/V2/Issuers1099Api.md +++ b/docs/A1099/V2/Issuers1099Api.md @@ -49,7 +49,7 @@ public class Example { Issuers1099Api apiInstance = new Issuers1099Api(apiClient); String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "019c2b9f-42e4-424f-a440-2de4183e50c9"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "0183bbfe-d8da-48ad-a320-b999accf40bd"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . IssuerRequest issuerRequest = new IssuerRequest(); // IssuerRequest | The issuer to create try { @@ -136,7 +136,7 @@ public class Example { Issuers1099Api apiInstance = new Issuers1099Api(apiClient); String id = "id_example"; // String | Id of the issuer to delete String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "2c4f0724-28b8-4321-940c-7aea4e6a1ae4"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "c0d08fe4-5eaf-4902-aa48-db347d045ba2"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { apiInstance.deleteIssuer(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -221,7 +221,7 @@ public class Example { Issuers1099Api apiInstance = new Issuers1099Api(apiClient); String id = "id_example"; // String | Id of the issuer to retrieve String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "e7d6ad5f-3589-4822-b711-bb658238ebf6"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "126ca6ac-f595-4b34-ada2-22cdd14960f5"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { IssuerResponse result = apiInstance.getIssuer(id, avalaraVersion, xCorrelationId, xAvalaraClient); @@ -312,7 +312,7 @@ public class Example { String $orderBy = "$orderBy_example"; // String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. Boolean count = true; // Boolean | If true, return the global count of elements in the collection. Boolean countOnly = true; // Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true. - String xCorrelationId = "2c3cf6e2-a30b-4934-8dad-94105b6b668c"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "51f8e5b5-bb09-4b2c-954f-f0f7b119003b"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { PaginatedQueryResultModelIssuerResponse result = apiInstance.getIssuers(avalaraVersion, $filter, $top, $skip, $orderBy, count, countOnly, xCorrelationId, xAvalaraClient); @@ -405,7 +405,7 @@ public class Example { Issuers1099Api apiInstance = new Issuers1099Api(apiClient); String id = "id_example"; // String | Id of the issuer to update String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "1d3cb56d-6c88-4c68-863a-81b0f64c270f"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "508db50e-5f2e-404d-9974-509003a9dfa8"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . IssuerRequest issuerRequest = new IssuerRequest(); // IssuerRequest | The issuer to update try { diff --git a/docs/A1099/V2/JobsApi.md b/docs/A1099/V2/JobsApi.md index 0f596b4..d5aed5c 100644 --- a/docs/A1099/V2/JobsApi.md +++ b/docs/A1099/V2/JobsApi.md @@ -46,7 +46,7 @@ public class Example { JobsApi apiInstance = new JobsApi(apiClient); String id = "id_example"; // String | Job id obtained from other API responses, like `/1099/bulk-upsert`. String avalaraVersion = "2.0.0"; // String | API version - String xCorrelationId = "a5bf9066-6d69-4811-95f8-646108327017"; // String | Unique correlation Id in a GUID format + String xCorrelationId = "44d0405b-1dec-4c17-8933-d5f2e21f598d"; // String | Unique correlation Id in a GUID format String xAvalaraClient = "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/) . try { JobResponse result = apiInstance.getJob(id, avalaraVersion, xCorrelationId, xAvalaraClient); diff --git a/docs/A1099/V2/W8BenEFormRequest.md b/docs/A1099/V2/W8BenEFormRequest.md index c967721..b82c447 100644 --- a/docs/A1099/V2/W8BenEFormRequest.md +++ b/docs/A1099/V2/W8BenEFormRequest.md @@ -11,18 +11,18 @@ |**name** | **String** | The name of the individual or entity associated with the form. | | |**citizenshipCountry** | **String** | The country of citizenship. | | |**disregardedEntity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] | -|**entityType** | **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 | | +|**entityType** | [**EntityTypeEnum**](#EntityTypeEnum) | 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 | | |**makingTreatyClaim** | **Boolean** | Indicates whether the entity is making a treaty claim. | [optional] | -|**fatcaStatus** | **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 | | +|**fatcaStatus** | [**FatcaStatusEnum**](#FatcaStatusEnum) | 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 | | |**residenceAddress** | **String** | The residential address of the individual or entity. | [optional] | |**residenceCity** | **String** | The city of residence. | [optional] | -|**residenceState** | **String** | The state of residence. | [optional] | +|**residenceState** | [**ResidenceStateEnum**](#ResidenceStateEnum) | The state of residence. | [optional] | |**residenceZip** | **String** | The ZIP code of the residence. | [optional] | |**residenceCountry** | **String** | The country of residence. | | |**residenceIsMailing** | **Boolean** | Indicates whether the residence address is also the mailing address. | [optional] | |**mailingAddress** | **String** | The mailing address. | [optional] | |**mailingCity** | **String** | The city of the mailing address. | [optional] | -|**mailingState** | **String** | The state of the mailing address. | [optional] | +|**mailingState** | [**MailingStateEnum**](#MailingStateEnum) | The state of the mailing address. | [optional] | |**mailingZip** | **String** | The ZIP code of the mailing address. | [optional] | |**mailingCountry** | **String** | The country of the mailing address. | [optional] | |**tin** | **String** | The taxpayer identification number (TIN). | [optional] | @@ -30,17 +30,17 @@ |**foreignTinNotRequired** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] | |**foreignTin** | **String** | The foreign taxpayer identification number (TIN). | [optional] | |**referenceNumber** | **String** | A reference number for the form. | [optional] | -|**disregardedEntityFatcaStatus** | **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] | +|**disregardedEntityFatcaStatus** | [**DisregardedEntityFatcaStatusEnum**](#DisregardedEntityFatcaStatusEnum) | 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] | |**disregardedAddress** | **String** | The address for disregarded entities. | [optional] | |**disregardedCity** | **String** | The city for disregarded entities. | [optional] | -|**disregardedState** | **String** | The state for disregarded entities. | [optional] | +|**disregardedState** | [**DisregardedStateEnum**](#DisregardedStateEnum) | The state for disregarded entities. | [optional] | |**disregardedZip** | **String** | The ZIP code for disregarded entities. | [optional] | |**disregardedCountry** | **String** | The country for disregarded entities. | [optional] | |**disregardedEntityGiin** | **String** | The GIIN for disregarded entities. | [optional] | |**treatyCountryCertification** | **Boolean** | Certifies the beneficial owner's country under the U.S. tax treaty. | [optional] | |**treatyCountry** | **String** | The treaty country of the beneficial owner. | [optional] | |**benefitLimitationCertification** | **Boolean** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional] | -|**benefitLimitation** | **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] | +|**benefitLimitation** | [**BenefitLimitationEnum**](#BenefitLimitationEnum) | 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] | |**qualifiedResidentStatusCertification** | **Boolean** | Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. | [optional] | |**treatyArticle** | **String** | Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits. | [optional] | |**withholdingRate** | **String** | Specifies the reduced withholding rate claimed under the applicable tax treaty. | [optional] | @@ -64,7 +64,7 @@ |**restrictedDistributorPreexistingSalesComplianceCertification** | **Boolean** | Certifies that the entity complies with distribution restrictions for U.S.-linked investors and has addressed any preexisting sales in accordance with FATCA regulations. | [optional] | |**nonreportingIgaFfiCertification** | **Boolean** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] | |**igaCountry** | **String** | The country for the applicable IGA with the United States. | [optional] | -|**igaModel** | **String** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] | +|**igaModel** | [**IgaModelEnum**](#IgaModelEnum) | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] | |**igaLegalStatusTreatment** | **String** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] | |**igaFfiTrusteeOrSponsor** | **String** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] | |**igaFfiTrusteeIsForeign** | **Boolean** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] | @@ -123,3 +123,308 @@ +## Enum: EntityTypeEnum + +| Name | Value | +|---- | -----| +| CORPORATION | "Corporation" | +| DISREGARDED_ENTITY | "DisregardedEntity" | +| PARTNERSHIP | "Partnership" | +| SIMPLE_TRUST | "SimpleTrust" | +| GRANTOR_TRUST | "GrantorTrust" | +| COMPLEX_TRUST | "ComplexTrust" | +| ESTATE | "Estate" | +| FOREIGN_GOVERNMENT_CONTROLLED_ENTITY | "ForeignGovernmentControlledEntity" | +| CENTRAL_BANK_OF_ISSUE | "CentralBankOfIssue" | +| TAX_EXEMPT_ORGANIZATION | "TaxExemptOrganization" | +| PRIVATE_FOUNDATION | "PrivateFoundation" | +| INTERNATIONAL_ORGANIZATION | "InternationalOrganization" | +| FOREIGN_GOVERNMENT_CONTROLLED_INTEGRAL_PART | "ForeignGovernmentControlledIntegralPart" | + + + +## Enum: FatcaStatusEnum + +| Name | Value | +|---- | -----| +| NONPARTICIPATING_FFI | "NonparticipatingFFI" | +| PARTICIPATING_FFI | "ParticipatingFFI" | +| REPORTING_MODEL1_FFI | "ReportingModel1FFI" | +| REPORTING_MODEL2_FFI | "ReportingModel2FFI" | +| REGISTERED_DEEMED_COMPLIANT_FFI | "RegisteredDeemedCompliantFFI" | +| SPONSORED_FFI_WITHOUT_GIIN | "SponsoredFFIWithoutGIIN" | +| CERTIFIED_DEEMED_COMPLIANT_NONREGISTERING_LOCAL_BANK | "CertifiedDeemedCompliantNonregisteringLocalBank" | +| CERTIFIED_DEEMED_COMPLIANT_FFI_WITH_LOW_VALUE_ACCOUNTS | "CertifiedDeemedCompliantFFIWithLowValueAccounts" | +| CERTIFIED_DEEMED_COMPLIANT_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE | "CertifiedDeemedCompliantSponsoredCloselyHeldInvestmentVehicle" | +| CERTIFIED_DEEMED_COMPLIANT_LIMITED_LIFE_DEBT_INVESTMENT_ENTITY | "CertifiedDeemedCompliantLimitedLifeDebtInvestmentEntity" | +| CERTAIN_INVESTMENT_ENTITIES_WITHOUT_FINANCIAL_ACCOUNTS | "CertainInvestmentEntitiesWithoutFinancialAccounts" | +| OWNER_DOCUMENTED_FFI | "OwnerDocumentedFFI" | +| RESTRICTED_DISTRIBUTOR | "RestrictedDistributor" | +| NONREPORTING_IGAFFI | "NonreportingIGAFFI" | +| FOREIGN_GOVERNMENT_OR_US_POSSESSION_OR_FOREIGN_CENTRAL_BANK | "ForeignGovernmentOrUSPossessionOrForeignCentralBank" | +| INTERNATIONAL_ORGANIZATION | "InternationalOrganization" | +| EXEMPT_RETIREMENT_PLANS | "ExemptRetirementPlans" | +| ENTITY_WHOLLY_OWNED_BY_EXEMPT_BENEFICIAL_OWNERS | "EntityWhollyOwnedByExemptBeneficialOwners" | +| TERRITORY_FINANCIAL_INSTITUTION | "TerritoryFinancialInstitution" | +| NONFINANCIAL_GROUP_ENTITY | "NonfinancialGroupEntity" | +| EXCEPTED_NONFINANCIAL_START_UP_COMPANY | "ExceptedNonfinancialStartUpCompany" | +| EXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCY | "ExceptedNonfinancialEntityInLiquidationOrBankruptcy" | +| ORGANIZATION501C | "Organization501c" | +| NONPROFIT_ORGANIZATION | "NonprofitOrganization" | +| PUBLICLY_TRADED_NFFEOR_AFFILIATE_OF_PUBLICLY_TRADED_CORPORATION | "PubliclyTradedNFFEOrAffiliateOfPubliclyTradedCorporation" | +| EXCEPTED_TERRITORY_NFFE | "ExceptedTerritoryNFFE" | +| ACTIVE_NFFE | "ActiveNFFE" | +| PASSIVE_NFFE | "PassiveNFFE" | +| EXCEPTED_INTER_AFFILIATE_FFI | "ExceptedInterAffiliateFFI" | +| DIRECT_REPORTING_NFFE | "DirectReportingNFFE" | +| SPONSORED_DIRECT_REPORTING_NFFE | "SponsoredDirectReportingNFFE" | +| ACCOUNT_THAT_IS_NOT_FINANCIAL_ACCOUNT | "AccountThatIsNotFinancialAccount" | + + + +## Enum: ResidenceStateEnum + +| Name | Value | +|---- | -----| +| AA | "AA" | +| AE | "AE" | +| AK | "AK" | +| AL | "AL" | +| AP | "AP" | +| AR | "AR" | +| AS | "AS" | +| AZ | "AZ" | +| CA | "CA" | +| CO | "CO" | +| CT | "CT" | +| DC | "DC" | +| DE | "DE" | +| FL | "FL" | +| FM | "FM" | +| GA | "GA" | +| GU | "GU" | +| HI | "HI" | +| IA | "IA" | +| ID | "ID" | +| IL | "IL" | +| IN | "IN" | +| KS | "KS" | +| KY | "KY" | +| LA | "LA" | +| MA | "MA" | +| MD | "MD" | +| ME | "ME" | +| MH | "MH" | +| MI | "MI" | +| MN | "MN" | +| MO | "MO" | +| MP | "MP" | +| MS | "MS" | +| MT | "MT" | +| NC | "NC" | +| ND | "ND" | +| NE | "NE" | +| NH | "NH" | +| NJ | "NJ" | +| NM | "NM" | +| NV | "NV" | +| NY | "NY" | +| OH | "OH" | +| OK | "OK" | +| OR | "OR" | +| PA | "PA" | +| PR | "PR" | +| PW | "PW" | +| RI | "RI" | +| SC | "SC" | +| SD | "SD" | +| TN | "TN" | +| TX | "TX" | +| UT | "UT" | +| VA | "VA" | +| VI | "VI" | +| VT | "VT" | +| WA | "WA" | +| WI | "WI" | +| WV | "WV" | +| WY | "WY" | + + + +## Enum: MailingStateEnum + +| Name | Value | +|---- | -----| +| AA | "AA" | +| AE | "AE" | +| AK | "AK" | +| AL | "AL" | +| AP | "AP" | +| AR | "AR" | +| AS | "AS" | +| AZ | "AZ" | +| CA | "CA" | +| CO | "CO" | +| CT | "CT" | +| DC | "DC" | +| DE | "DE" | +| FL | "FL" | +| FM | "FM" | +| GA | "GA" | +| GU | "GU" | +| HI | "HI" | +| IA | "IA" | +| ID | "ID" | +| IL | "IL" | +| IN | "IN" | +| KS | "KS" | +| KY | "KY" | +| LA | "LA" | +| MA | "MA" | +| MD | "MD" | +| ME | "ME" | +| MH | "MH" | +| MI | "MI" | +| MN | "MN" | +| MO | "MO" | +| MP | "MP" | +| MS | "MS" | +| MT | "MT" | +| NC | "NC" | +| ND | "ND" | +| NE | "NE" | +| NH | "NH" | +| NJ | "NJ" | +| NM | "NM" | +| NV | "NV" | +| NY | "NY" | +| OH | "OH" | +| OK | "OK" | +| OR | "OR" | +| PA | "PA" | +| PR | "PR" | +| PW | "PW" | +| RI | "RI" | +| SC | "SC" | +| SD | "SD" | +| TN | "TN" | +| TX | "TX" | +| UT | "UT" | +| VA | "VA" | +| VI | "VI" | +| VT | "VT" | +| WA | "WA" | +| WI | "WI" | +| WV | "WV" | +| WY | "WY" | + + + +## Enum: DisregardedEntityFatcaStatusEnum + +| Name | Value | +|---- | -----| +| BRANCH_TREATED_AS_NONPARTICIPATING_FFI | "BranchTreatedAsNonparticipatingFFI" | +| US_BRANCH | "USBranch" | +| PARTICIPATING_FFI | "ParticipatingFFI" | +| REPORTING_MODEL1_FFI | "ReportingModel1FFI" | +| REPORTING_MODEL2_FFI | "ReportingModel2FFI" | + + + +## Enum: DisregardedStateEnum + +| Name | Value | +|---- | -----| +| AA | "AA" | +| AE | "AE" | +| AK | "AK" | +| AL | "AL" | +| AP | "AP" | +| AR | "AR" | +| AS | "AS" | +| AZ | "AZ" | +| CA | "CA" | +| CO | "CO" | +| CT | "CT" | +| DC | "DC" | +| DE | "DE" | +| FL | "FL" | +| FM | "FM" | +| GA | "GA" | +| GU | "GU" | +| HI | "HI" | +| IA | "IA" | +| ID | "ID" | +| IL | "IL" | +| IN | "IN" | +| KS | "KS" | +| KY | "KY" | +| LA | "LA" | +| MA | "MA" | +| MD | "MD" | +| ME | "ME" | +| MH | "MH" | +| MI | "MI" | +| MN | "MN" | +| MO | "MO" | +| MP | "MP" | +| MS | "MS" | +| MT | "MT" | +| NC | "NC" | +| ND | "ND" | +| NE | "NE" | +| NH | "NH" | +| NJ | "NJ" | +| NM | "NM" | +| NV | "NV" | +| NY | "NY" | +| OH | "OH" | +| OK | "OK" | +| OR | "OR" | +| PA | "PA" | +| PR | "PR" | +| PW | "PW" | +| RI | "RI" | +| SC | "SC" | +| SD | "SD" | +| TN | "TN" | +| TX | "TX" | +| UT | "UT" | +| VA | "VA" | +| VI | "VI" | +| VT | "VT" | +| WA | "WA" | +| WI | "WI" | +| WV | "WV" | +| WY | "WY" | + + + +## Enum: BenefitLimitationEnum + +| Name | Value | +|---- | -----| +| GOVERNMENT | "Government" | +| TAX_EXEMPT_PENSION_TRUST_OR_PENSION_FUND | "TaxExemptPensionTrustOrPensionFund" | +| OTHER_TAX_EXEMPT_ORGANIZATION | "OtherTaxExemptOrganization" | +| PUBLICLY_TRADED_CORPORATION | "PubliclyTradedCorporation" | +| SUBSIDIARY_OF_PUBLICLY_TRADED_CORPORATION | "SubsidiaryOfPubliclyTradedCorporation" | +| COMPANY_THAT_MEETS_OWNERSHIP_AND_BASE_EROSION_TEST | "CompanyThatMeetsOwnershipAndBaseErosionTest" | +| COMPANY_THAT_MEETS_DERIVATIVE_BENEFITS_TEST | "CompanyThatMeetsDerivativeBenefitsTest" | +| COMPANY_WITH_ITEM_OF_INCOME_THAT_MEETS_ACTIVE_TRADE_OR_BUSINESS_TEST | "CompanyWithItemOfIncomeThatMeetsActiveTradeOrBusinessTest" | +| FAVORABLE_DISCRETIONARY_DETERMINATION_BY_US_COMPETENT_AUTHORITY_RECEIVED | "FavorableDiscretionaryDeterminationByUSCompetentAuthorityReceived" | +| OTHER | "Other" | +| NO_LOB_ARTICLE_IN_TREATY | "NoLOBArticleInTreaty" | + + + +## Enum: IgaModelEnum + +| Name | Value | +|---- | -----| +| MODEL1_IGA | "Model1IGA" | +| MODEL2_IGA | "Model2IGA" | + + + diff --git a/docs/A1099/V2/W8BenFormRequest.md b/docs/A1099/V2/W8BenFormRequest.md index 5936463..d519b96 100644 --- a/docs/A1099/V2/W8BenFormRequest.md +++ b/docs/A1099/V2/W8BenFormRequest.md @@ -9,27 +9,27 @@ |------------ | ------------- | ------------- | -------------| |**type** | [**TypeEnum**](#TypeEnum) | The form type (always \"w8ben\" for this model). | [optional] [readonly] | |**name** | **String** | The name of the individual or entity associated with the form. | | -|**citizenshipCountry** | **String** | The country of citizenship. | | +|**citizenshipCountry** | [**CitizenshipCountryEnum**](#CitizenshipCountryEnum) | The country of citizenship.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | | |**residenceAddress** | **String** | The residential address of the individual or entity. | [optional] | |**residenceCity** | **String** | The city of residence. | [optional] | -|**residenceState** | **String** | The state of residence. | [optional] | +|**residenceState** | [**ResidenceStateEnum**](#ResidenceStateEnum) | 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] | |**residenceZip** | **String** | The ZIP code of the residence. | [optional] | -|**residenceCountry** | **String** | The country of residence. | | +|**residenceCountry** | [**ResidenceCountryEnum**](#ResidenceCountryEnum) | The country of residence.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | | |**residenceIsMailing** | **Boolean** | Indicates whether the residence address is the mailing address. | [optional] | |**mailingAddress** | **String** | The mailing address. | [optional] | |**mailingCity** | **String** | The city of the mailing address. | [optional] | -|**mailingState** | **String** | The state of the mailing address. | [optional] | +|**mailingState** | [**MailingStateEnum**](#MailingStateEnum) | 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] | |**mailingZip** | **String** | The ZIP code of the mailing address. | [optional] | -|**mailingCountry** | **String** | The country of the mailing address. | | +|**mailingCountry** | [**MailingCountryEnum**](#MailingCountryEnum) | The country of the mailing address.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | | |**tin** | **String** | The taxpayer identification number (TIN). | [optional] | |**foreignTinNotRequired** | **Boolean** | Indicates whether a foreign TIN is not legally required. | [optional] | |**foreignTin** | **String** | The foreign taxpayer identification number (TIN). | [optional] | |**referenceNumber** | **String** | A reference number for the form. | [optional] | |**birthday** | **LocalDate** | The birthday of the individual associated with the form. | [optional] | -|**treatyCountry** | **String** | The country for which the treaty applies. | [optional] | +|**treatyCountry** | [**TreatyCountryEnum**](#TreatyCountryEnum) | The country for which the treaty applies.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | [optional] | |**treatyArticle** | **String** | The specific article of the treaty being claimed. | [optional] | |**treatyReasons** | **String** | The reasons for claiming treaty benefits. | [optional] | -|**withholdingRate** | **String** | The withholding rate applied as per the treaty. | [optional] | +|**withholdingRate** | [**WithholdingRateEnum**](#WithholdingRateEnum) | 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] | |**incomeType** | **String** | The type of income covered by the treaty. | [optional] | |**signerName** | **String** | The name of the signer of the form. | [optional] | |**eDeliveryConsentedAt** | **OffsetDateTime** | The date when e-delivery was consented. | [optional] | @@ -52,3 +52,1245 @@ +## Enum: CitizenshipCountryEnum + +| Name | Value | +|---- | -----| +| US | "US" | +| AF | "AF" | +| AX | "AX" | +| AL | "AL" | +| AG | "AG" | +| AQ | "AQ" | +| AN | "AN" | +| AO | "AO" | +| AV | "AV" | +| AY | "AY" | +| AC | "AC" | +| AR | "AR" | +| AM | "AM" | +| AA | "AA" | +| AT | "AT" | +| AS | "AS" | +| AU | "AU" | +| AJ | "AJ" | +| BF | "BF" | +| BA | "BA" | +| FQ | "FQ" | +| BG | "BG" | +| BB | "BB" | +| BO | "BO" | +| BE | "BE" | +| BH | "BH" | +| BN | "BN" | +| BD | "BD" | +| BT | "BT" | +| BL | "BL" | +| BK | "BK" | +| BC | "BC" | +| BV | "BV" | +| BR | "BR" | +| IO | "IO" | +| VI | "VI" | +| BX | "BX" | +| BU | "BU" | +| UV | "UV" | +| BM | "BM" | +| BY | "BY" | +| CB | "CB" | +| CM | "CM" | +| CA | "CA" | +| CV | "CV" | +| CJ | "CJ" | +| CT | "CT" | +| CD | "CD" | +| CI | "CI" | +| CH | "CH" | +| KT | "KT" | +| IP | "IP" | +| CK | "CK" | +| CO | "CO" | +| CN | "CN" | +| CF | "CF" | +| CG | "CG" | +| CW | "CW" | +| CR | "CR" | +| CS | "CS" | +| IV | "IV" | +| HR | "HR" | +| CU | "CU" | +| UC | "UC" | +| CY | "CY" | +| EZ | "EZ" | +| DA | "DA" | +| DX | "DX" | +| DJ | "DJ" | +| DO | "DO" | +| DR | "DR" | +| TT | "TT" | +| EC | "EC" | +| EG | "EG" | +| ES | "ES" | +| EK | "EK" | +| ER | "ER" | +| EN | "EN" | +| ET | "ET" | +| FK | "FK" | +| FO | "FO" | +| FM | "FM" | +| FJ | "FJ" | +| FI | "FI" | +| FR | "FR" | +| FP | "FP" | +| FS | "FS" | +| GB | "GB" | +| GA | "GA" | +| GG | "GG" | +| GM | "GM" | +| GH | "GH" | +| GI | "GI" | +| GR | "GR" | +| GL | "GL" | +| GJ | "GJ" | +| GQ | "GQ" | +| GT | "GT" | +| GK | "GK" | +| GV | "GV" | +| PU | "PU" | +| GY | "GY" | +| HA | "HA" | +| HM | "HM" | +| VT | "VT" | +| HO | "HO" | +| HK | "HK" | +| HQ | "HQ" | +| HU | "HU" | +| IC | "IC" | +| IN | "IN" | +| ID | "ID" | +| IR | "IR" | +| IZ | "IZ" | +| EI | "EI" | +| IS | "IS" | +| IT | "IT" | +| JM | "JM" | +| JN | "JN" | +| JA | "JA" | +| DQ | "DQ" | +| JE | "JE" | +| JQ | "JQ" | +| JO | "JO" | +| KZ | "KZ" | +| KE | "KE" | +| KQ | "KQ" | +| KR | "KR" | +| KN | "KN" | +| KS | "KS" | +| KV | "KV" | +| KU | "KU" | +| KG | "KG" | +| LA | "LA" | +| LG | "LG" | +| LE | "LE" | +| LT | "LT" | +| LI | "LI" | +| LY | "LY" | +| LS | "LS" | +| LH | "LH" | +| LU | "LU" | +| MC | "MC" | +| MK | "MK" | +| MA | "MA" | +| MI | "MI" | +| MY | "MY" | +| MV | "MV" | +| ML | "ML" | +| MT | "MT" | +| IM | "IM" | +| RM | "RM" | +| MR | "MR" | +| MP | "MP" | +| MX | "MX" | +| MQ | "MQ" | +| MD | "MD" | +| MN | "MN" | +| MG | "MG" | +| MJ | "MJ" | +| MH | "MH" | +| MO | "MO" | +| MZ | "MZ" | +| WA | "WA" | +| NR | "NR" | +| BQ | "BQ" | +| NP | "NP" | +| NL | "NL" | +| NC | "NC" | +| NZ | "NZ" | +| NU | "NU" | +| NG | "NG" | +| NI | "NI" | +| NE | "NE" | +| NF | "NF" | +| CQ | "CQ" | +| NO | "NO" | +| MU | "MU" | +| OC | "OC" | +| PK | "PK" | +| PS | "PS" | +| LQ | "LQ" | +| PM | "PM" | +| PP | "PP" | +| PF | "PF" | +| PA | "PA" | +| PE | "PE" | +| RP | "RP" | +| PC | "PC" | +| PL | "PL" | +| PO | "PO" | +| RQ | "RQ" | +| QA | "QA" | +| RO | "RO" | +| RS | "RS" | +| RW | "RW" | +| TB | "TB" | +| RN | "RN" | +| WS | "WS" | +| SM | "SM" | +| TP | "TP" | +| SA | "SA" | +| SG | "SG" | +| RI | "RI" | +| SE | "SE" | +| SL | "SL" | +| SN | "SN" | +| NN | "NN" | +| LO | "LO" | +| SI | "SI" | +| BP | "BP" | +| SO | "SO" | +| SF | "SF" | +| SX | "SX" | +| SP | "SP" | +| PG | "PG" | +| CE | "CE" | +| SH | "SH" | +| SC | "SC" | +| ST | "ST" | +| SB | "SB" | +| VC | "VC" | +| SU | "SU" | +| NS | "NS" | +| SV | "SV" | +| WZ | "WZ" | +| SW | "SW" | +| SZ | "SZ" | +| SY | "SY" | +| TW | "TW" | +| TI | "TI" | +| TZ | "TZ" | +| TH | "TH" | +| TO | "TO" | +| TL | "TL" | +| TN | "TN" | +| TD | "TD" | +| TS | "TS" | +| TU | "TU" | +| TX | "TX" | +| TK | "TK" | +| TV | "TV" | +| UG | "UG" | +| UP | "UP" | +| AE | "AE" | +| UK | "UK" | +| UY | "UY" | +| UZ | "UZ" | +| NH | "NH" | +| VE | "VE" | +| VM | "VM" | +| VQ | "VQ" | +| WQ | "WQ" | +| WF | "WF" | +| WI | "WI" | +| YM | "YM" | +| ZA | "ZA" | +| ZI | "ZI" | + + + +## Enum: ResidenceStateEnum + +| Name | Value | +|---- | -----| +| AA | "AA" | +| AE | "AE" | +| AK | "AK" | +| AL | "AL" | +| AP | "AP" | +| AR | "AR" | +| AS | "AS" | +| AZ | "AZ" | +| CA | "CA" | +| CO | "CO" | +| CT | "CT" | +| DC | "DC" | +| DE | "DE" | +| FL | "FL" | +| FM | "FM" | +| GA | "GA" | +| GU | "GU" | +| HI | "HI" | +| IA | "IA" | +| ID | "ID" | +| IL | "IL" | +| IN | "IN" | +| KS | "KS" | +| KY | "KY" | +| LA | "LA" | +| MA | "MA" | +| MD | "MD" | +| ME | "ME" | +| MH | "MH" | +| MI | "MI" | +| MN | "MN" | +| MO | "MO" | +| MP | "MP" | +| MS | "MS" | +| MT | "MT" | +| NC | "NC" | +| ND | "ND" | +| NE | "NE" | +| NH | "NH" | +| NJ | "NJ" | +| NM | "NM" | +| NV | "NV" | +| NY | "NY" | +| OH | "OH" | +| OK | "OK" | +| OR | "OR" | +| PA | "PA" | +| PR | "PR" | +| PW | "PW" | +| RI | "RI" | +| SC | "SC" | +| SD | "SD" | +| TN | "TN" | +| TX | "TX" | +| UT | "UT" | +| VA | "VA" | +| VI | "VI" | +| VT | "VT" | +| WA | "WA" | +| WI | "WI" | +| WV | "WV" | +| WY | "WY" | +| AB | "AB" | +| BC | "BC" | +| MB | "MB" | +| NB | "NB" | +| NL | "NL" | +| NS | "NS" | +| NT | "NT" | +| NU | "NU" | +| ON | "ON" | +| PE | "PE" | +| QC | "QC" | +| SK | "SK" | +| YT | "YT" | + + + +## Enum: ResidenceCountryEnum + +| Name | Value | +|---- | -----| +| US | "US" | +| AF | "AF" | +| AX | "AX" | +| AL | "AL" | +| AG | "AG" | +| AQ | "AQ" | +| AN | "AN" | +| AO | "AO" | +| AV | "AV" | +| AY | "AY" | +| AC | "AC" | +| AR | "AR" | +| AM | "AM" | +| AA | "AA" | +| AT | "AT" | +| AS | "AS" | +| AU | "AU" | +| AJ | "AJ" | +| BF | "BF" | +| BA | "BA" | +| FQ | "FQ" | +| BG | "BG" | +| BB | "BB" | +| BO | "BO" | +| BE | "BE" | +| BH | "BH" | +| BN | "BN" | +| BD | "BD" | +| BT | "BT" | +| BL | "BL" | +| BK | "BK" | +| BC | "BC" | +| BV | "BV" | +| BR | "BR" | +| IO | "IO" | +| VI | "VI" | +| BX | "BX" | +| BU | "BU" | +| UV | "UV" | +| BM | "BM" | +| BY | "BY" | +| CB | "CB" | +| CM | "CM" | +| CA | "CA" | +| CV | "CV" | +| CJ | "CJ" | +| CT | "CT" | +| CD | "CD" | +| CI | "CI" | +| CH | "CH" | +| KT | "KT" | +| IP | "IP" | +| CK | "CK" | +| CO | "CO" | +| CN | "CN" | +| CF | "CF" | +| CG | "CG" | +| CW | "CW" | +| CR | "CR" | +| CS | "CS" | +| IV | "IV" | +| HR | "HR" | +| CU | "CU" | +| UC | "UC" | +| CY | "CY" | +| EZ | "EZ" | +| DA | "DA" | +| DX | "DX" | +| DJ | "DJ" | +| DO | "DO" | +| DR | "DR" | +| TT | "TT" | +| EC | "EC" | +| EG | "EG" | +| ES | "ES" | +| EK | "EK" | +| ER | "ER" | +| EN | "EN" | +| ET | "ET" | +| FK | "FK" | +| FO | "FO" | +| FM | "FM" | +| FJ | "FJ" | +| FI | "FI" | +| FR | "FR" | +| FP | "FP" | +| FS | "FS" | +| GB | "GB" | +| GA | "GA" | +| GG | "GG" | +| GM | "GM" | +| GH | "GH" | +| GI | "GI" | +| GR | "GR" | +| GL | "GL" | +| GJ | "GJ" | +| GQ | "GQ" | +| GT | "GT" | +| GK | "GK" | +| GV | "GV" | +| PU | "PU" | +| GY | "GY" | +| HA | "HA" | +| HM | "HM" | +| VT | "VT" | +| HO | "HO" | +| HK | "HK" | +| HQ | "HQ" | +| HU | "HU" | +| IC | "IC" | +| IN | "IN" | +| ID | "ID" | +| IR | "IR" | +| IZ | "IZ" | +| EI | "EI" | +| IS | "IS" | +| IT | "IT" | +| JM | "JM" | +| JN | "JN" | +| JA | "JA" | +| DQ | "DQ" | +| JE | "JE" | +| JQ | "JQ" | +| JO | "JO" | +| KZ | "KZ" | +| KE | "KE" | +| KQ | "KQ" | +| KR | "KR" | +| KN | "KN" | +| KS | "KS" | +| KV | "KV" | +| KU | "KU" | +| KG | "KG" | +| LA | "LA" | +| LG | "LG" | +| LE | "LE" | +| LT | "LT" | +| LI | "LI" | +| LY | "LY" | +| LS | "LS" | +| LH | "LH" | +| LU | "LU" | +| MC | "MC" | +| MK | "MK" | +| MA | "MA" | +| MI | "MI" | +| MY | "MY" | +| MV | "MV" | +| ML | "ML" | +| MT | "MT" | +| IM | "IM" | +| RM | "RM" | +| MR | "MR" | +| MP | "MP" | +| MX | "MX" | +| MQ | "MQ" | +| MD | "MD" | +| MN | "MN" | +| MG | "MG" | +| MJ | "MJ" | +| MH | "MH" | +| MO | "MO" | +| MZ | "MZ" | +| WA | "WA" | +| NR | "NR" | +| BQ | "BQ" | +| NP | "NP" | +| NL | "NL" | +| NC | "NC" | +| NZ | "NZ" | +| NU | "NU" | +| NG | "NG" | +| NI | "NI" | +| NE | "NE" | +| NF | "NF" | +| CQ | "CQ" | +| NO | "NO" | +| MU | "MU" | +| OC | "OC" | +| PK | "PK" | +| PS | "PS" | +| LQ | "LQ" | +| PM | "PM" | +| PP | "PP" | +| PF | "PF" | +| PA | "PA" | +| PE | "PE" | +| RP | "RP" | +| PC | "PC" | +| PL | "PL" | +| PO | "PO" | +| RQ | "RQ" | +| QA | "QA" | +| RO | "RO" | +| RS | "RS" | +| RW | "RW" | +| TB | "TB" | +| RN | "RN" | +| WS | "WS" | +| SM | "SM" | +| TP | "TP" | +| SA | "SA" | +| SG | "SG" | +| RI | "RI" | +| SE | "SE" | +| SL | "SL" | +| SN | "SN" | +| NN | "NN" | +| LO | "LO" | +| SI | "SI" | +| BP | "BP" | +| SO | "SO" | +| SF | "SF" | +| SX | "SX" | +| SP | "SP" | +| PG | "PG" | +| CE | "CE" | +| SH | "SH" | +| SC | "SC" | +| ST | "ST" | +| SB | "SB" | +| VC | "VC" | +| SU | "SU" | +| NS | "NS" | +| SV | "SV" | +| WZ | "WZ" | +| SW | "SW" | +| SZ | "SZ" | +| SY | "SY" | +| TW | "TW" | +| TI | "TI" | +| TZ | "TZ" | +| TH | "TH" | +| TO | "TO" | +| TL | "TL" | +| TN | "TN" | +| TD | "TD" | +| TS | "TS" | +| TU | "TU" | +| TX | "TX" | +| TK | "TK" | +| TV | "TV" | +| UG | "UG" | +| UP | "UP" | +| AE | "AE" | +| UK | "UK" | +| UY | "UY" | +| UZ | "UZ" | +| NH | "NH" | +| VE | "VE" | +| VM | "VM" | +| VQ | "VQ" | +| WQ | "WQ" | +| WF | "WF" | +| WI | "WI" | +| YM | "YM" | +| ZA | "ZA" | +| ZI | "ZI" | + + + +## Enum: MailingStateEnum + +| Name | Value | +|---- | -----| +| AA | "AA" | +| AE | "AE" | +| AK | "AK" | +| AL | "AL" | +| AP | "AP" | +| AR | "AR" | +| AS | "AS" | +| AZ | "AZ" | +| CA | "CA" | +| CO | "CO" | +| CT | "CT" | +| DC | "DC" | +| DE | "DE" | +| FL | "FL" | +| FM | "FM" | +| GA | "GA" | +| GU | "GU" | +| HI | "HI" | +| IA | "IA" | +| ID | "ID" | +| IL | "IL" | +| IN | "IN" | +| KS | "KS" | +| KY | "KY" | +| LA | "LA" | +| MA | "MA" | +| MD | "MD" | +| ME | "ME" | +| MH | "MH" | +| MI | "MI" | +| MN | "MN" | +| MO | "MO" | +| MP | "MP" | +| MS | "MS" | +| MT | "MT" | +| NC | "NC" | +| ND | "ND" | +| NE | "NE" | +| NH | "NH" | +| NJ | "NJ" | +| NM | "NM" | +| NV | "NV" | +| NY | "NY" | +| OH | "OH" | +| OK | "OK" | +| OR | "OR" | +| PA | "PA" | +| PR | "PR" | +| PW | "PW" | +| RI | "RI" | +| SC | "SC" | +| SD | "SD" | +| TN | "TN" | +| TX | "TX" | +| UT | "UT" | +| VA | "VA" | +| VI | "VI" | +| VT | "VT" | +| WA | "WA" | +| WI | "WI" | +| WV | "WV" | +| WY | "WY" | +| AB | "AB" | +| BC | "BC" | +| MB | "MB" | +| NB | "NB" | +| NL | "NL" | +| NS | "NS" | +| NT | "NT" | +| NU | "NU" | +| ON | "ON" | +| PE | "PE" | +| QC | "QC" | +| SK | "SK" | +| YT | "YT" | + + + +## Enum: MailingCountryEnum + +| Name | Value | +|---- | -----| +| US | "US" | +| AF | "AF" | +| AX | "AX" | +| AL | "AL" | +| AG | "AG" | +| AQ | "AQ" | +| AN | "AN" | +| AO | "AO" | +| AV | "AV" | +| AY | "AY" | +| AC | "AC" | +| AR | "AR" | +| AM | "AM" | +| AA | "AA" | +| AT | "AT" | +| AS | "AS" | +| AU | "AU" | +| AJ | "AJ" | +| BF | "BF" | +| BA | "BA" | +| FQ | "FQ" | +| BG | "BG" | +| BB | "BB" | +| BO | "BO" | +| BE | "BE" | +| BH | "BH" | +| BN | "BN" | +| BD | "BD" | +| BT | "BT" | +| BL | "BL" | +| BK | "BK" | +| BC | "BC" | +| BV | "BV" | +| BR | "BR" | +| IO | "IO" | +| VI | "VI" | +| BX | "BX" | +| BU | "BU" | +| UV | "UV" | +| BM | "BM" | +| BY | "BY" | +| CB | "CB" | +| CM | "CM" | +| CA | "CA" | +| CV | "CV" | +| CJ | "CJ" | +| CT | "CT" | +| CD | "CD" | +| CI | "CI" | +| CH | "CH" | +| KT | "KT" | +| IP | "IP" | +| CK | "CK" | +| CO | "CO" | +| CN | "CN" | +| CF | "CF" | +| CG | "CG" | +| CW | "CW" | +| CR | "CR" | +| CS | "CS" | +| IV | "IV" | +| HR | "HR" | +| CU | "CU" | +| UC | "UC" | +| CY | "CY" | +| EZ | "EZ" | +| DA | "DA" | +| DX | "DX" | +| DJ | "DJ" | +| DO | "DO" | +| DR | "DR" | +| TT | "TT" | +| EC | "EC" | +| EG | "EG" | +| ES | "ES" | +| EK | "EK" | +| ER | "ER" | +| EN | "EN" | +| ET | "ET" | +| FK | "FK" | +| FO | "FO" | +| FM | "FM" | +| FJ | "FJ" | +| FI | "FI" | +| FR | "FR" | +| FP | "FP" | +| FS | "FS" | +| GB | "GB" | +| GA | "GA" | +| GG | "GG" | +| GM | "GM" | +| GH | "GH" | +| GI | "GI" | +| GR | "GR" | +| GL | "GL" | +| GJ | "GJ" | +| GQ | "GQ" | +| GT | "GT" | +| GK | "GK" | +| GV | "GV" | +| PU | "PU" | +| GY | "GY" | +| HA | "HA" | +| HM | "HM" | +| VT | "VT" | +| HO | "HO" | +| HK | "HK" | +| HQ | "HQ" | +| HU | "HU" | +| IC | "IC" | +| IN | "IN" | +| ID | "ID" | +| IR | "IR" | +| IZ | "IZ" | +| EI | "EI" | +| IS | "IS" | +| IT | "IT" | +| JM | "JM" | +| JN | "JN" | +| JA | "JA" | +| DQ | "DQ" | +| JE | "JE" | +| JQ | "JQ" | +| JO | "JO" | +| KZ | "KZ" | +| KE | "KE" | +| KQ | "KQ" | +| KR | "KR" | +| KN | "KN" | +| KS | "KS" | +| KV | "KV" | +| KU | "KU" | +| KG | "KG" | +| LA | "LA" | +| LG | "LG" | +| LE | "LE" | +| LT | "LT" | +| LI | "LI" | +| LY | "LY" | +| LS | "LS" | +| LH | "LH" | +| LU | "LU" | +| MC | "MC" | +| MK | "MK" | +| MA | "MA" | +| MI | "MI" | +| MY | "MY" | +| MV | "MV" | +| ML | "ML" | +| MT | "MT" | +| IM | "IM" | +| RM | "RM" | +| MR | "MR" | +| MP | "MP" | +| MX | "MX" | +| MQ | "MQ" | +| MD | "MD" | +| MN | "MN" | +| MG | "MG" | +| MJ | "MJ" | +| MH | "MH" | +| MO | "MO" | +| MZ | "MZ" | +| WA | "WA" | +| NR | "NR" | +| BQ | "BQ" | +| NP | "NP" | +| NL | "NL" | +| NC | "NC" | +| NZ | "NZ" | +| NU | "NU" | +| NG | "NG" | +| NI | "NI" | +| NE | "NE" | +| NF | "NF" | +| CQ | "CQ" | +| NO | "NO" | +| MU | "MU" | +| OC | "OC" | +| PK | "PK" | +| PS | "PS" | +| LQ | "LQ" | +| PM | "PM" | +| PP | "PP" | +| PF | "PF" | +| PA | "PA" | +| PE | "PE" | +| RP | "RP" | +| PC | "PC" | +| PL | "PL" | +| PO | "PO" | +| RQ | "RQ" | +| QA | "QA" | +| RO | "RO" | +| RS | "RS" | +| RW | "RW" | +| TB | "TB" | +| RN | "RN" | +| WS | "WS" | +| SM | "SM" | +| TP | "TP" | +| SA | "SA" | +| SG | "SG" | +| RI | "RI" | +| SE | "SE" | +| SL | "SL" | +| SN | "SN" | +| NN | "NN" | +| LO | "LO" | +| SI | "SI" | +| BP | "BP" | +| SO | "SO" | +| SF | "SF" | +| SX | "SX" | +| SP | "SP" | +| PG | "PG" | +| CE | "CE" | +| SH | "SH" | +| SC | "SC" | +| ST | "ST" | +| SB | "SB" | +| VC | "VC" | +| SU | "SU" | +| NS | "NS" | +| SV | "SV" | +| WZ | "WZ" | +| SW | "SW" | +| SZ | "SZ" | +| SY | "SY" | +| TW | "TW" | +| TI | "TI" | +| TZ | "TZ" | +| TH | "TH" | +| TO | "TO" | +| TL | "TL" | +| TN | "TN" | +| TD | "TD" | +| TS | "TS" | +| TU | "TU" | +| TX | "TX" | +| TK | "TK" | +| TV | "TV" | +| UG | "UG" | +| UP | "UP" | +| AE | "AE" | +| UK | "UK" | +| UY | "UY" | +| UZ | "UZ" | +| NH | "NH" | +| VE | "VE" | +| VM | "VM" | +| VQ | "VQ" | +| WQ | "WQ" | +| WF | "WF" | +| WI | "WI" | +| YM | "YM" | +| ZA | "ZA" | +| ZI | "ZI" | + + + +## Enum: TreatyCountryEnum + +| Name | Value | +|---- | -----| +| US | "US" | +| AF | "AF" | +| AX | "AX" | +| AL | "AL" | +| AG | "AG" | +| AQ | "AQ" | +| AN | "AN" | +| AO | "AO" | +| AV | "AV" | +| AY | "AY" | +| AC | "AC" | +| AR | "AR" | +| AM | "AM" | +| AA | "AA" | +| AT | "AT" | +| AS | "AS" | +| AU | "AU" | +| AJ | "AJ" | +| BF | "BF" | +| BA | "BA" | +| FQ | "FQ" | +| BG | "BG" | +| BB | "BB" | +| BO | "BO" | +| BE | "BE" | +| BH | "BH" | +| BN | "BN" | +| BD | "BD" | +| BT | "BT" | +| BL | "BL" | +| BK | "BK" | +| BC | "BC" | +| BV | "BV" | +| BR | "BR" | +| IO | "IO" | +| VI | "VI" | +| BX | "BX" | +| BU | "BU" | +| UV | "UV" | +| BM | "BM" | +| BY | "BY" | +| CB | "CB" | +| CM | "CM" | +| CA | "CA" | +| CV | "CV" | +| CJ | "CJ" | +| CT | "CT" | +| CD | "CD" | +| CI | "CI" | +| CH | "CH" | +| KT | "KT" | +| IP | "IP" | +| CK | "CK" | +| CO | "CO" | +| CN | "CN" | +| CF | "CF" | +| CG | "CG" | +| CW | "CW" | +| CR | "CR" | +| CS | "CS" | +| IV | "IV" | +| HR | "HR" | +| CU | "CU" | +| UC | "UC" | +| CY | "CY" | +| EZ | "EZ" | +| DA | "DA" | +| DX | "DX" | +| DJ | "DJ" | +| DO | "DO" | +| DR | "DR" | +| TT | "TT" | +| EC | "EC" | +| EG | "EG" | +| ES | "ES" | +| EK | "EK" | +| ER | "ER" | +| EN | "EN" | +| ET | "ET" | +| FK | "FK" | +| FO | "FO" | +| FM | "FM" | +| FJ | "FJ" | +| FI | "FI" | +| FR | "FR" | +| FP | "FP" | +| FS | "FS" | +| GB | "GB" | +| GA | "GA" | +| GG | "GG" | +| GM | "GM" | +| GH | "GH" | +| GI | "GI" | +| GR | "GR" | +| GL | "GL" | +| GJ | "GJ" | +| GQ | "GQ" | +| GT | "GT" | +| GK | "GK" | +| GV | "GV" | +| PU | "PU" | +| GY | "GY" | +| HA | "HA" | +| HM | "HM" | +| VT | "VT" | +| HO | "HO" | +| HK | "HK" | +| HQ | "HQ" | +| HU | "HU" | +| IC | "IC" | +| IN | "IN" | +| ID | "ID" | +| IR | "IR" | +| IZ | "IZ" | +| EI | "EI" | +| IS | "IS" | +| IT | "IT" | +| JM | "JM" | +| JN | "JN" | +| JA | "JA" | +| DQ | "DQ" | +| JE | "JE" | +| JQ | "JQ" | +| JO | "JO" | +| KZ | "KZ" | +| KE | "KE" | +| KQ | "KQ" | +| KR | "KR" | +| KN | "KN" | +| KS | "KS" | +| KV | "KV" | +| KU | "KU" | +| KG | "KG" | +| LA | "LA" | +| LG | "LG" | +| LE | "LE" | +| LT | "LT" | +| LI | "LI" | +| LY | "LY" | +| LS | "LS" | +| LH | "LH" | +| LU | "LU" | +| MC | "MC" | +| MK | "MK" | +| MA | "MA" | +| MI | "MI" | +| MY | "MY" | +| MV | "MV" | +| ML | "ML" | +| MT | "MT" | +| IM | "IM" | +| RM | "RM" | +| MR | "MR" | +| MP | "MP" | +| MX | "MX" | +| MQ | "MQ" | +| MD | "MD" | +| MN | "MN" | +| MG | "MG" | +| MJ | "MJ" | +| MH | "MH" | +| MO | "MO" | +| MZ | "MZ" | +| WA | "WA" | +| NR | "NR" | +| BQ | "BQ" | +| NP | "NP" | +| NL | "NL" | +| NC | "NC" | +| NZ | "NZ" | +| NU | "NU" | +| NG | "NG" | +| NI | "NI" | +| NE | "NE" | +| NF | "NF" | +| CQ | "CQ" | +| NO | "NO" | +| MU | "MU" | +| OC | "OC" | +| PK | "PK" | +| PS | "PS" | +| LQ | "LQ" | +| PM | "PM" | +| PP | "PP" | +| PF | "PF" | +| PA | "PA" | +| PE | "PE" | +| RP | "RP" | +| PC | "PC" | +| PL | "PL" | +| PO | "PO" | +| RQ | "RQ" | +| QA | "QA" | +| RO | "RO" | +| RS | "RS" | +| RW | "RW" | +| TB | "TB" | +| RN | "RN" | +| WS | "WS" | +| SM | "SM" | +| TP | "TP" | +| SA | "SA" | +| SG | "SG" | +| RI | "RI" | +| SE | "SE" | +| SL | "SL" | +| SN | "SN" | +| NN | "NN" | +| LO | "LO" | +| SI | "SI" | +| BP | "BP" | +| SO | "SO" | +| SF | "SF" | +| SX | "SX" | +| SP | "SP" | +| PG | "PG" | +| CE | "CE" | +| SH | "SH" | +| SC | "SC" | +| ST | "ST" | +| SB | "SB" | +| VC | "VC" | +| SU | "SU" | +| NS | "NS" | +| SV | "SV" | +| WZ | "WZ" | +| SW | "SW" | +| SZ | "SZ" | +| SY | "SY" | +| TW | "TW" | +| TI | "TI" | +| TZ | "TZ" | +| TH | "TH" | +| TO | "TO" | +| TL | "TL" | +| TN | "TN" | +| TD | "TD" | +| TS | "TS" | +| TU | "TU" | +| TX | "TX" | +| TK | "TK" | +| TV | "TV" | +| UG | "UG" | +| UP | "UP" | +| AE | "AE" | +| UK | "UK" | +| UY | "UY" | +| UZ | "UZ" | +| NH | "NH" | +| VE | "VE" | +| VM | "VM" | +| VQ | "VQ" | +| WQ | "WQ" | +| WF | "WF" | +| WI | "WI" | +| YM | "YM" | +| ZA | "ZA" | +| ZI | "ZI" | + + + +## Enum: WithholdingRateEnum + +| Name | Value | +|---- | -----| +| _0 | "0" | +| _0_0 | "0.0" | +| _0_00 | "0.00" | +| _5 | "5" | +| _5_5 | "5.5" | +| _10 | "10" | +| _12_50 | "12.50" | +| _15 | "15" | +| _20 | "20" | +| _25 | "25" | +| _30 | "30" | + + + diff --git a/pom.xml b/pom.xml index 109181b..bdcf85e 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ avalara-sdk jar avalara-sdk - 25.10.0 + 25.10.1 https://github.com/avadev/Avalara-SDK-Java OpenAPI Java diff --git a/src/main/java/Avalara/SDK/api/A1099/V2/CompaniesW9Api.java b/src/main/java/Avalara/SDK/api/A1099/V2/CompaniesW9Api.java index d657566..5e41321 100644 --- a/src/main/java/Avalara/SDK/api/A1099/V2/CompaniesW9Api.java +++ b/src/main/java/Avalara/SDK/api/A1099/V2/CompaniesW9Api.java @@ -1089,7 +1089,7 @@ public UpdateCompanyRequest getUpdateCompanyRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/A1099/V2/Forms1099Api.java b/src/main/java/Avalara/SDK/api/A1099/V2/Forms1099Api.java index 4785fff..0d25a68 100644 --- a/src/main/java/Avalara/SDK/api/A1099/V2/Forms1099Api.java +++ b/src/main/java/Avalara/SDK/api/A1099/V2/Forms1099Api.java @@ -1509,7 +1509,7 @@ public Update1099FormRequest getUpdate1099FormRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/A1099/V2/FormsW9Api.java b/src/main/java/Avalara/SDK/api/A1099/V2/FormsW9Api.java index df91bbb..d5c8ea1 100644 --- a/src/main/java/Avalara/SDK/api/A1099/V2/FormsW9Api.java +++ b/src/main/java/Avalara/SDK/api/A1099/V2/FormsW9Api.java @@ -823,6 +823,196 @@ public GetW9FormRequest getGetW9FormRequest() { return this.new GetW9FormRequest(); } + /** + * Build call for getW9FormPdf + * @param requestOptions Object which represents the options available for a given API/request + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 PDF stream -
400 Bad request (e.g., invalid id) -
401 Authentication failed -
404 W9/W4/W8 form not found -
+ */ + public okhttp3.Call getW9FormPdfCall(GetW9FormPdfRequest requestParameters, final ApiCallback _callback) throws ApiException { + String basePath = null; + + // Operation Servers + String[] localBasePaths = new String[] { }; + + //OAuth2 Scopes + String requiredScopes = ""; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/w9/forms/{id}/pdf" + .replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(requestParameters.id.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (requestParameters.getAvalaraVersion() != null) { + localVarHeaderParams.put("avalara-version", localVarApiClient.parameterToString(requestParameters.getAvalaraVersion())); + } + + if (requestParameters.getXCorrelationId() != null) { + localVarHeaderParams.put("X-Correlation-Id", localVarApiClient.parameterToString(requestParameters.getXCorrelationId())); + } + + if (requestParameters.getXAvalaraClient() != null) { + localVarHeaderParams.put("X-Avalara-Client", localVarApiClient.parameterToString(requestParameters.getXAvalaraClient())); + } + + final String[] localVarAccepts = { + "application/pdf", "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null && !localVarHeaderParams.containsKey("Accept")) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + String[] localVarAuthNames = new String[] { "OAuth", "bearer" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback, requiredScopes, AvalaraMicroservice.A1099); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getW9FormPdfValidateBeforeCall(GetW9FormPdfRequest requestParameters, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'requestParameters.id' is set + if (requestParameters.getId() == null) { + throw new ApiException("Missing the required parameter 'requestParameters.id' when calling getW9FormPdf(Async)"); + } + + // verify the required parameter 'requestParameters.avalaraVersion' is set + if (requestParameters.getAvalaraVersion() == null) { + throw new ApiException("Missing the required parameter 'requestParameters.avalaraVersion' when calling getW9FormPdf(Async)"); + } + + + okhttp3.Call localVarCall = getW9FormPdfCall(requestParameters, _callback); + return localVarCall; + + } + + /** + * Download the PDF for a W9/W4/W8 form. + * Returns the PDF file for a W9/W4/W8 form. + * @param requestOptions Object which represents the options available for a given API/request + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 PDF stream -
400 Bad request (e.g., invalid id) -
401 Authentication failed -
404 W9/W4/W8 form not found -
+ */ + public void getW9FormPdf(GetW9FormPdfRequest requestParameters) throws ApiException { + getW9FormPdfWithHttpInfo(requestParameters); + } + + /** + * Download the PDF for a W9/W4/W8 form. + * Returns the PDF file for a W9/W4/W8 form. + * @param requestOptions Object which represents the options available for a given API/request + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 PDF stream -
400 Bad request (e.g., invalid id) -
401 Authentication failed -
404 W9/W4/W8 form not found -
+ */ + public ApiResponse getW9FormPdfWithHttpInfo(GetW9FormPdfRequest requestParameters) throws ApiException { + okhttp3.Call localVarCall = getW9FormPdfValidateBeforeCall(requestParameters, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * Download the PDF for a W9/W4/W8 form. (asynchronously) + * Returns the PDF file for a W9/W4/W8 form. + * @param requestOptions Object which represents the options available for a given API/request + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 PDF stream -
400 Bad request (e.g., invalid id) -
401 Authentication failed -
404 W9/W4/W8 form not found -
+ */ + public okhttp3.Call getW9FormPdfAsync(GetW9FormPdfRequest requestParameters, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getW9FormPdfValidateBeforeCall(requestParameters, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Represents the Request object for the GetW9FormPdf API + * + * @param id Id of the form + * @param avalaraVersion API version + * @param xCorrelationId Unique correlation Id in a GUID format (optional) + * @param xAvalaraClient 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) + */ + public class GetW9FormPdfRequest { + private String id; + private String avalaraVersion; + private String xCorrelationId; + private String xAvalaraClient; + + public GetW9FormPdfRequest () { + } + + public String getId() { return id; } + public void setId(String id) { this.id = id; } + public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "2.0"; } + public void setAvalaraVersion(String avalaraVersion) { this.avalaraVersion = avalaraVersion; } + public String getXCorrelationId() { return xCorrelationId; } + public void setXCorrelationId(String xCorrelationId) { this.xCorrelationId = xCorrelationId; } + public String getXAvalaraClient() { return xAvalaraClient; } + public void setXAvalaraClient(String xAvalaraClient) { this.xAvalaraClient = xAvalaraClient; } + } + + /** + * Getter function to instantiate Request class + * @returns GetW9FormPdfRequest + */ + public GetW9FormPdfRequest getGetW9FormPdfRequest() { + return this.new GetW9FormPdfRequest(); + } + /** * Build call for listW9Forms * @param requestOptions Object which represents the options available for a given API/request @@ -1647,7 +1837,7 @@ public UploadW9FilesRequest getUploadW9FilesRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/A1099/V2/Issuers1099Api.java b/src/main/java/Avalara/SDK/api/A1099/V2/Issuers1099Api.java index cfb47e5..2731db1 100644 --- a/src/main/java/Avalara/SDK/api/A1099/V2/Issuers1099Api.java +++ b/src/main/java/Avalara/SDK/api/A1099/V2/Issuers1099Api.java @@ -1069,7 +1069,7 @@ public UpdateIssuerRequest getUpdateIssuerRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/A1099/V2/JobsApi.java b/src/main/java/Avalara/SDK/api/A1099/V2/JobsApi.java index 7dc5e13..8b82a87 100644 --- a/src/main/java/Avalara/SDK/api/A1099/V2/JobsApi.java +++ b/src/main/java/Avalara/SDK/api/A1099/V2/JobsApi.java @@ -275,7 +275,7 @@ public GetJobRequest getGetJobRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/DataInputFieldsApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/DataInputFieldsApi.java index 1fd80c3..3d69e15 100644 --- a/src/main/java/Avalara/SDK/api/EInvoicing/V1/DataInputFieldsApi.java +++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/DataInputFieldsApi.java @@ -294,7 +294,7 @@ public GetDataInputFieldsRequest getGetDataInputFieldsRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/DocumentsApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/DocumentsApi.java index 5041d23..78f4e31 100644 --- a/src/main/java/Avalara/SDK/api/EInvoicing/V1/DocumentsApi.java +++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/DocumentsApi.java @@ -1105,7 +1105,7 @@ public SubmitDocumentRequest getSubmitDocumentRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/InteropApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/InteropApi.java index dbbaa05..db3e597 100644 --- a/src/main/java/Avalara/SDK/api/EInvoicing/V1/InteropApi.java +++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/InteropApi.java @@ -300,7 +300,7 @@ public SubmitInteropDocumentRequest getSubmitInteropDocumentRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/MandatesApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/MandatesApi.java index 2bc3302..63d3fa5 100644 --- a/src/main/java/Avalara/SDK/api/EInvoicing/V1/MandatesApi.java +++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/MandatesApi.java @@ -521,7 +521,7 @@ public GetMandatesRequest getGetMandatesRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/SubscriptionsApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/SubscriptionsApi.java index 32a006f..78a02cd 100644 --- a/src/main/java/Avalara/SDK/api/EInvoicing/V1/SubscriptionsApi.java +++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/SubscriptionsApi.java @@ -873,7 +873,7 @@ public ListWebhookSubscriptionsRequest getListWebhookSubscriptionsRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/TaxIdentifiersApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/TaxIdentifiersApi.java index 89f380d..2f3debf 100644 --- a/src/main/java/Avalara/SDK/api/EInvoicing/V1/TaxIdentifiersApi.java +++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/TaxIdentifiersApi.java @@ -489,7 +489,7 @@ public ValidateTaxIdentifierRequest getValidateTaxIdentifierRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/TradingPartnersApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/TradingPartnersApi.java index 6923f91..2a28b3a 100644 --- a/src/main/java/Avalara/SDK/api/EInvoicing/V1/TradingPartnersApi.java +++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/TradingPartnersApi.java @@ -1993,7 +1993,7 @@ public UpdateTradingPartnerRequest getUpdateTradingPartnerRequest() { private void SetConfiguration(ApiClient client) { if (client == null) throw new MissingFormatArgumentException("client"); - this.localVarApiClient.setSdkVersion("25.10.0"); + this.localVarApiClient.setSdkVersion("25.10.1"); } } diff --git a/src/main/java/Avalara/SDK/model/A1099/V2/W8BenEFormRequest.java b/src/main/java/Avalara/SDK/model/A1099/V2/W8BenEFormRequest.java index 8eeb7ef..d130123 100644 --- a/src/main/java/Avalara/SDK/model/A1099/V2/W8BenEFormRequest.java +++ b/src/main/java/Avalara/SDK/model/A1099/V2/W8BenEFormRequest.java @@ -137,17 +137,203 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_DISREGARDED_ENTITY) private String disregardedEntity; + /** + * 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 + */ + @JsonAdapter(EntityTypeEnum.Adapter.class) + public enum EntityTypeEnum { + CORPORATION("Corporation"), + + DISREGARDED_ENTITY("DisregardedEntity"), + + PARTNERSHIP("Partnership"), + + SIMPLE_TRUST("SimpleTrust"), + + GRANTOR_TRUST("GrantorTrust"), + + COMPLEX_TRUST("ComplexTrust"), + + ESTATE("Estate"), + + FOREIGN_GOVERNMENT_CONTROLLED_ENTITY("ForeignGovernmentControlledEntity"), + + CENTRAL_BANK_OF_ISSUE("CentralBankOfIssue"), + + TAX_EXEMPT_ORGANIZATION("TaxExemptOrganization"), + + PRIVATE_FOUNDATION("PrivateFoundation"), + + INTERNATIONAL_ORGANIZATION("InternationalOrganization"), + + FOREIGN_GOVERNMENT_CONTROLLED_INTEGRAL_PART("ForeignGovernmentControlledIntegralPart"); + + private String value; + + EntityTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static EntityTypeEnum fromValue(String value) { + for (EntityTypeEnum b : EntityTypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final EntityTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public EntityTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return EntityTypeEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + EntityTypeEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_ENTITY_TYPE = "entityType"; @SerializedName(SERIALIZED_NAME_ENTITY_TYPE) - private String entityType; + private EntityTypeEnum entityType; public static final String SERIALIZED_NAME_MAKING_TREATY_CLAIM = "makingTreatyClaim"; @SerializedName(SERIALIZED_NAME_MAKING_TREATY_CLAIM) private Boolean makingTreatyClaim; + /** + * 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 + */ + @JsonAdapter(FatcaStatusEnum.Adapter.class) + public enum FatcaStatusEnum { + NONPARTICIPATING_FFI("NonparticipatingFFI"), + + PARTICIPATING_FFI("ParticipatingFFI"), + + REPORTING_MODEL1_FFI("ReportingModel1FFI"), + + REPORTING_MODEL2_FFI("ReportingModel2FFI"), + + REGISTERED_DEEMED_COMPLIANT_FFI("RegisteredDeemedCompliantFFI"), + + SPONSORED_FFI_WITHOUT_GIIN("SponsoredFFIWithoutGIIN"), + + CERTIFIED_DEEMED_COMPLIANT_NONREGISTERING_LOCAL_BANK("CertifiedDeemedCompliantNonregisteringLocalBank"), + + CERTIFIED_DEEMED_COMPLIANT_FFI_WITH_LOW_VALUE_ACCOUNTS("CertifiedDeemedCompliantFFIWithLowValueAccounts"), + + CERTIFIED_DEEMED_COMPLIANT_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE("CertifiedDeemedCompliantSponsoredCloselyHeldInvestmentVehicle"), + + CERTIFIED_DEEMED_COMPLIANT_LIMITED_LIFE_DEBT_INVESTMENT_ENTITY("CertifiedDeemedCompliantLimitedLifeDebtInvestmentEntity"), + + CERTAIN_INVESTMENT_ENTITIES_WITHOUT_FINANCIAL_ACCOUNTS("CertainInvestmentEntitiesWithoutFinancialAccounts"), + + OWNER_DOCUMENTED_FFI("OwnerDocumentedFFI"), + + RESTRICTED_DISTRIBUTOR("RestrictedDistributor"), + + NONREPORTING_IGAFFI("NonreportingIGAFFI"), + + FOREIGN_GOVERNMENT_OR_US_POSSESSION_OR_FOREIGN_CENTRAL_BANK("ForeignGovernmentOrUSPossessionOrForeignCentralBank"), + + INTERNATIONAL_ORGANIZATION("InternationalOrganization"), + + EXEMPT_RETIREMENT_PLANS("ExemptRetirementPlans"), + + ENTITY_WHOLLY_OWNED_BY_EXEMPT_BENEFICIAL_OWNERS("EntityWhollyOwnedByExemptBeneficialOwners"), + + TERRITORY_FINANCIAL_INSTITUTION("TerritoryFinancialInstitution"), + + NONFINANCIAL_GROUP_ENTITY("NonfinancialGroupEntity"), + + EXCEPTED_NONFINANCIAL_START_UP_COMPANY("ExceptedNonfinancialStartUpCompany"), + + EXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCY("ExceptedNonfinancialEntityInLiquidationOrBankruptcy"), + + ORGANIZATION501C("Organization501c"), + + NONPROFIT_ORGANIZATION("NonprofitOrganization"), + + PUBLICLY_TRADED_NFFEOR_AFFILIATE_OF_PUBLICLY_TRADED_CORPORATION("PubliclyTradedNFFEOrAffiliateOfPubliclyTradedCorporation"), + + EXCEPTED_TERRITORY_NFFE("ExceptedTerritoryNFFE"), + + ACTIVE_NFFE("ActiveNFFE"), + + PASSIVE_NFFE("PassiveNFFE"), + + EXCEPTED_INTER_AFFILIATE_FFI("ExceptedInterAffiliateFFI"), + + DIRECT_REPORTING_NFFE("DirectReportingNFFE"), + + SPONSORED_DIRECT_REPORTING_NFFE("SponsoredDirectReportingNFFE"), + + ACCOUNT_THAT_IS_NOT_FINANCIAL_ACCOUNT("AccountThatIsNotFinancialAccount"); + + private String value; + + FatcaStatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static FatcaStatusEnum fromValue(String value) { + for (FatcaStatusEnum b : FatcaStatusEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final FatcaStatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public FatcaStatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return FatcaStatusEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + FatcaStatusEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_FATCA_STATUS = "fatcaStatus"; @SerializedName(SERIALIZED_NAME_FATCA_STATUS) - private String fatcaStatus; + private FatcaStatusEnum fatcaStatus; public static final String SERIALIZED_NAME_RESIDENCE_ADDRESS = "residenceAddress"; @SerializedName(SERIALIZED_NAME_RESIDENCE_ADDRESS) @@ -157,9 +343,181 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_RESIDENCE_CITY) private String residenceCity; + /** + * The state of residence. + */ + @JsonAdapter(ResidenceStateEnum.Adapter.class) + public enum ResidenceStateEnum { + AA("AA"), + + AE("AE"), + + AK("AK"), + + AL("AL"), + + AP("AP"), + + AR("AR"), + + AS("AS"), + + AZ("AZ"), + + CA("CA"), + + CO("CO"), + + CT("CT"), + + DC("DC"), + + DE("DE"), + + FL("FL"), + + FM("FM"), + + GA("GA"), + + GU("GU"), + + HI("HI"), + + IA("IA"), + + ID("ID"), + + IL("IL"), + + IN("IN"), + + KS("KS"), + + KY("KY"), + + LA("LA"), + + MA("MA"), + + MD("MD"), + + ME("ME"), + + MH("MH"), + + MI("MI"), + + MN("MN"), + + MO("MO"), + + MP("MP"), + + MS("MS"), + + MT("MT"), + + NC("NC"), + + ND("ND"), + + NE("NE"), + + NH("NH"), + + NJ("NJ"), + + NM("NM"), + + NV("NV"), + + NY("NY"), + + OH("OH"), + + OK("OK"), + + OR("OR"), + + PA("PA"), + + PR("PR"), + + PW("PW"), + + RI("RI"), + + SC("SC"), + + SD("SD"), + + TN("TN"), + + TX("TX"), + + UT("UT"), + + VA("VA"), + + VI("VI"), + + VT("VT"), + + WA("WA"), + + WI("WI"), + + WV("WV"), + + WY("WY"); + + private String value; + + ResidenceStateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ResidenceStateEnum fromValue(String value) { + for (ResidenceStateEnum b : ResidenceStateEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ResidenceStateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ResidenceStateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ResidenceStateEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + ResidenceStateEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_RESIDENCE_STATE = "residenceState"; @SerializedName(SERIALIZED_NAME_RESIDENCE_STATE) - private String residenceState; + private ResidenceStateEnum residenceState; public static final String SERIALIZED_NAME_RESIDENCE_ZIP = "residenceZip"; @SerializedName(SERIALIZED_NAME_RESIDENCE_ZIP) @@ -169,21 +527,193 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_RESIDENCE_COUNTRY) private String residenceCountry; - public static final String SERIALIZED_NAME_RESIDENCE_IS_MAILING = "residenceIsMailing"; - @SerializedName(SERIALIZED_NAME_RESIDENCE_IS_MAILING) - private Boolean residenceIsMailing; + public static final String SERIALIZED_NAME_RESIDENCE_IS_MAILING = "residenceIsMailing"; + @SerializedName(SERIALIZED_NAME_RESIDENCE_IS_MAILING) + private Boolean residenceIsMailing; + + public static final String SERIALIZED_NAME_MAILING_ADDRESS = "mailingAddress"; + @SerializedName(SERIALIZED_NAME_MAILING_ADDRESS) + private String mailingAddress; + + public static final String SERIALIZED_NAME_MAILING_CITY = "mailingCity"; + @SerializedName(SERIALIZED_NAME_MAILING_CITY) + private String mailingCity; + + /** + * The state of the mailing address. + */ + @JsonAdapter(MailingStateEnum.Adapter.class) + public enum MailingStateEnum { + AA("AA"), + + AE("AE"), + + AK("AK"), + + AL("AL"), + + AP("AP"), + + AR("AR"), + + AS("AS"), + + AZ("AZ"), + + CA("CA"), + + CO("CO"), + + CT("CT"), + + DC("DC"), + + DE("DE"), + + FL("FL"), + + FM("FM"), + + GA("GA"), + + GU("GU"), + + HI("HI"), + + IA("IA"), + + ID("ID"), + + IL("IL"), + + IN("IN"), + + KS("KS"), + + KY("KY"), + + LA("LA"), + + MA("MA"), + + MD("MD"), + + ME("ME"), + + MH("MH"), + + MI("MI"), + + MN("MN"), + + MO("MO"), + + MP("MP"), + + MS("MS"), + + MT("MT"), + + NC("NC"), + + ND("ND"), + + NE("NE"), + + NH("NH"), + + NJ("NJ"), + + NM("NM"), + + NV("NV"), + + NY("NY"), + + OH("OH"), + + OK("OK"), + + OR("OR"), + + PA("PA"), + + PR("PR"), + + PW("PW"), + + RI("RI"), + + SC("SC"), + + SD("SD"), + + TN("TN"), + + TX("TX"), + + UT("UT"), + + VA("VA"), + + VI("VI"), + + VT("VT"), + + WA("WA"), + + WI("WI"), + + WV("WV"), + + WY("WY"); + + private String value; + + MailingStateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static MailingStateEnum fromValue(String value) { + for (MailingStateEnum b : MailingStateEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final MailingStateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } - public static final String SERIALIZED_NAME_MAILING_ADDRESS = "mailingAddress"; - @SerializedName(SERIALIZED_NAME_MAILING_ADDRESS) - private String mailingAddress; + @Override + public MailingStateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return MailingStateEnum.fromValue(value); + } + } - public static final String SERIALIZED_NAME_MAILING_CITY = "mailingCity"; - @SerializedName(SERIALIZED_NAME_MAILING_CITY) - private String mailingCity; + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + MailingStateEnum.fromValue(value); + } + } public static final String SERIALIZED_NAME_MAILING_STATE = "mailingState"; @SerializedName(SERIALIZED_NAME_MAILING_STATE) - private String mailingState; + private MailingStateEnum mailingState; public static final String SERIALIZED_NAME_MAILING_ZIP = "mailingZip"; @SerializedName(SERIALIZED_NAME_MAILING_ZIP) @@ -213,9 +743,67 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_REFERENCE_NUMBER) private String referenceNumber; + /** + * 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 + */ + @JsonAdapter(DisregardedEntityFatcaStatusEnum.Adapter.class) + public enum DisregardedEntityFatcaStatusEnum { + BRANCH_TREATED_AS_NONPARTICIPATING_FFI("BranchTreatedAsNonparticipatingFFI"), + + US_BRANCH("USBranch"), + + PARTICIPATING_FFI("ParticipatingFFI"), + + REPORTING_MODEL1_FFI("ReportingModel1FFI"), + + REPORTING_MODEL2_FFI("ReportingModel2FFI"); + + private String value; + + DisregardedEntityFatcaStatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static DisregardedEntityFatcaStatusEnum fromValue(String value) { + for (DisregardedEntityFatcaStatusEnum b : DisregardedEntityFatcaStatusEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final DisregardedEntityFatcaStatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public DisregardedEntityFatcaStatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return DisregardedEntityFatcaStatusEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + DisregardedEntityFatcaStatusEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_DISREGARDED_ENTITY_FATCA_STATUS = "disregardedEntityFatcaStatus"; @SerializedName(SERIALIZED_NAME_DISREGARDED_ENTITY_FATCA_STATUS) - private String disregardedEntityFatcaStatus; + private DisregardedEntityFatcaStatusEnum disregardedEntityFatcaStatus; public static final String SERIALIZED_NAME_DISREGARDED_ADDRESS = "disregardedAddress"; @SerializedName(SERIALIZED_NAME_DISREGARDED_ADDRESS) @@ -225,9 +813,181 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_DISREGARDED_CITY) private String disregardedCity; + /** + * The state for disregarded entities. + */ + @JsonAdapter(DisregardedStateEnum.Adapter.class) + public enum DisregardedStateEnum { + AA("AA"), + + AE("AE"), + + AK("AK"), + + AL("AL"), + + AP("AP"), + + AR("AR"), + + AS("AS"), + + AZ("AZ"), + + CA("CA"), + + CO("CO"), + + CT("CT"), + + DC("DC"), + + DE("DE"), + + FL("FL"), + + FM("FM"), + + GA("GA"), + + GU("GU"), + + HI("HI"), + + IA("IA"), + + ID("ID"), + + IL("IL"), + + IN("IN"), + + KS("KS"), + + KY("KY"), + + LA("LA"), + + MA("MA"), + + MD("MD"), + + ME("ME"), + + MH("MH"), + + MI("MI"), + + MN("MN"), + + MO("MO"), + + MP("MP"), + + MS("MS"), + + MT("MT"), + + NC("NC"), + + ND("ND"), + + NE("NE"), + + NH("NH"), + + NJ("NJ"), + + NM("NM"), + + NV("NV"), + + NY("NY"), + + OH("OH"), + + OK("OK"), + + OR("OR"), + + PA("PA"), + + PR("PR"), + + PW("PW"), + + RI("RI"), + + SC("SC"), + + SD("SD"), + + TN("TN"), + + TX("TX"), + + UT("UT"), + + VA("VA"), + + VI("VI"), + + VT("VT"), + + WA("WA"), + + WI("WI"), + + WV("WV"), + + WY("WY"); + + private String value; + + DisregardedStateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static DisregardedStateEnum fromValue(String value) { + for (DisregardedStateEnum b : DisregardedStateEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final DisregardedStateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public DisregardedStateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return DisregardedStateEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + DisregardedStateEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_DISREGARDED_STATE = "disregardedState"; @SerializedName(SERIALIZED_NAME_DISREGARDED_STATE) - private String disregardedState; + private DisregardedStateEnum disregardedState; public static final String SERIALIZED_NAME_DISREGARDED_ZIP = "disregardedZip"; @SerializedName(SERIALIZED_NAME_DISREGARDED_ZIP) @@ -253,9 +1013,79 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_BENEFIT_LIMITATION_CERTIFICATION) private Boolean benefitLimitationCertification; + /** + * 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 + */ + @JsonAdapter(BenefitLimitationEnum.Adapter.class) + public enum BenefitLimitationEnum { + GOVERNMENT("Government"), + + TAX_EXEMPT_PENSION_TRUST_OR_PENSION_FUND("TaxExemptPensionTrustOrPensionFund"), + + OTHER_TAX_EXEMPT_ORGANIZATION("OtherTaxExemptOrganization"), + + PUBLICLY_TRADED_CORPORATION("PubliclyTradedCorporation"), + + SUBSIDIARY_OF_PUBLICLY_TRADED_CORPORATION("SubsidiaryOfPubliclyTradedCorporation"), + + COMPANY_THAT_MEETS_OWNERSHIP_AND_BASE_EROSION_TEST("CompanyThatMeetsOwnershipAndBaseErosionTest"), + + COMPANY_THAT_MEETS_DERIVATIVE_BENEFITS_TEST("CompanyThatMeetsDerivativeBenefitsTest"), + + COMPANY_WITH_ITEM_OF_INCOME_THAT_MEETS_ACTIVE_TRADE_OR_BUSINESS_TEST("CompanyWithItemOfIncomeThatMeetsActiveTradeOrBusinessTest"), + + FAVORABLE_DISCRETIONARY_DETERMINATION_BY_US_COMPETENT_AUTHORITY_RECEIVED("FavorableDiscretionaryDeterminationByUSCompetentAuthorityReceived"), + + OTHER("Other"), + + NO_LOB_ARTICLE_IN_TREATY("NoLOBArticleInTreaty"); + + private String value; + + BenefitLimitationEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static BenefitLimitationEnum fromValue(String value) { + for (BenefitLimitationEnum b : BenefitLimitationEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final BenefitLimitationEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public BenefitLimitationEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return BenefitLimitationEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + BenefitLimitationEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_BENEFIT_LIMITATION = "benefitLimitation"; @SerializedName(SERIALIZED_NAME_BENEFIT_LIMITATION) - private String benefitLimitation; + private BenefitLimitationEnum benefitLimitation; public static final String SERIALIZED_NAME_QUALIFIED_RESIDENT_STATUS_CERTIFICATION = "qualifiedResidentStatusCertification"; @SerializedName(SERIALIZED_NAME_QUALIFIED_RESIDENT_STATUS_CERTIFICATION) @@ -349,9 +1179,61 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_IGA_COUNTRY) private String igaCountry; + /** + * The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA + */ + @JsonAdapter(IgaModelEnum.Adapter.class) + public enum IgaModelEnum { + MODEL1_IGA("Model1IGA"), + + MODEL2_IGA("Model2IGA"); + + private String value; + + IgaModelEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static IgaModelEnum fromValue(String value) { + for (IgaModelEnum b : IgaModelEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final IgaModelEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public IgaModelEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return IgaModelEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + IgaModelEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_IGA_MODEL = "igaModel"; @SerializedName(SERIALIZED_NAME_IGA_MODEL) - private String igaModel; + private IgaModelEnum igaModel; public static final String SERIALIZED_NAME_IGA_LEGAL_STATUS_TREATMENT = "igaLegalStatusTreatment"; @SerializedName(SERIALIZED_NAME_IGA_LEGAL_STATUS_TREATMENT) @@ -603,21 +1485,21 @@ public void setDisregardedEntity(String disregardedEntity) { } - public W8BenEFormRequest entityType(String entityType) { + public W8BenEFormRequest entityType(EntityTypeEnum entityType) { this.entityType = entityType; return this; } /** - * 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 + * 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 * @return entityType */ @javax.annotation.Nonnull - public String getEntityType() { + public EntityTypeEnum getEntityType() { return entityType; } - public void setEntityType(String entityType) { + public void setEntityType(EntityTypeEnum entityType) { this.entityType = entityType; } @@ -641,21 +1523,21 @@ public void setMakingTreatyClaim(Boolean makingTreatyClaim) { } - public W8BenEFormRequest fatcaStatus(String fatcaStatus) { + public W8BenEFormRequest fatcaStatus(FatcaStatusEnum fatcaStatus) { this.fatcaStatus = fatcaStatus; return this; } /** - * 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 + * 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 * @return fatcaStatus */ @javax.annotation.Nonnull - public String getFatcaStatus() { + public FatcaStatusEnum getFatcaStatus() { return fatcaStatus; } - public void setFatcaStatus(String fatcaStatus) { + public void setFatcaStatus(FatcaStatusEnum fatcaStatus) { this.fatcaStatus = fatcaStatus; } @@ -698,7 +1580,7 @@ public void setResidenceCity(String residenceCity) { } - public W8BenEFormRequest residenceState(String residenceState) { + public W8BenEFormRequest residenceState(ResidenceStateEnum residenceState) { this.residenceState = residenceState; return this; } @@ -708,11 +1590,11 @@ public W8BenEFormRequest residenceState(String residenceState) { * @return residenceState */ @javax.annotation.Nullable - public String getResidenceState() { + public ResidenceStateEnum getResidenceState() { return residenceState; } - public void setResidenceState(String residenceState) { + public void setResidenceState(ResidenceStateEnum residenceState) { this.residenceState = residenceState; } @@ -812,7 +1694,7 @@ public void setMailingCity(String mailingCity) { } - public W8BenEFormRequest mailingState(String mailingState) { + public W8BenEFormRequest mailingState(MailingStateEnum mailingState) { this.mailingState = mailingState; return this; } @@ -822,11 +1704,11 @@ public W8BenEFormRequest mailingState(String mailingState) { * @return mailingState */ @javax.annotation.Nullable - public String getMailingState() { + public MailingStateEnum getMailingState() { return mailingState; } - public void setMailingState(String mailingState) { + public void setMailingState(MailingStateEnum mailingState) { this.mailingState = mailingState; } @@ -964,21 +1846,21 @@ public void setReferenceNumber(String referenceNumber) { } - public W8BenEFormRequest disregardedEntityFatcaStatus(String disregardedEntityFatcaStatus) { + public W8BenEFormRequest disregardedEntityFatcaStatus(DisregardedEntityFatcaStatusEnum disregardedEntityFatcaStatus) { this.disregardedEntityFatcaStatus = disregardedEntityFatcaStatus; return this; } /** - * 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 + * 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 * @return disregardedEntityFatcaStatus */ @javax.annotation.Nullable - public String getDisregardedEntityFatcaStatus() { + public DisregardedEntityFatcaStatusEnum getDisregardedEntityFatcaStatus() { return disregardedEntityFatcaStatus; } - public void setDisregardedEntityFatcaStatus(String disregardedEntityFatcaStatus) { + public void setDisregardedEntityFatcaStatus(DisregardedEntityFatcaStatusEnum disregardedEntityFatcaStatus) { this.disregardedEntityFatcaStatus = disregardedEntityFatcaStatus; } @@ -1021,7 +1903,7 @@ public void setDisregardedCity(String disregardedCity) { } - public W8BenEFormRequest disregardedState(String disregardedState) { + public W8BenEFormRequest disregardedState(DisregardedStateEnum disregardedState) { this.disregardedState = disregardedState; return this; } @@ -1031,11 +1913,11 @@ public W8BenEFormRequest disregardedState(String disregardedState) { * @return disregardedState */ @javax.annotation.Nullable - public String getDisregardedState() { + public DisregardedStateEnum getDisregardedState() { return disregardedState; } - public void setDisregardedState(String disregardedState) { + public void setDisregardedState(DisregardedStateEnum disregardedState) { this.disregardedState = disregardedState; } @@ -1154,21 +2036,21 @@ public void setBenefitLimitationCertification(Boolean benefitLimitationCertifica } - public W8BenEFormRequest benefitLimitation(String benefitLimitation) { + public W8BenEFormRequest benefitLimitation(BenefitLimitationEnum benefitLimitation) { this.benefitLimitation = benefitLimitation; return this; } /** - * 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 + * 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 * @return benefitLimitation */ @javax.annotation.Nullable - public String getBenefitLimitation() { + public BenefitLimitationEnum getBenefitLimitation() { return benefitLimitation; } - public void setBenefitLimitation(String benefitLimitation) { + public void setBenefitLimitation(BenefitLimitationEnum benefitLimitation) { this.benefitLimitation = benefitLimitation; } @@ -1610,7 +2492,7 @@ public void setIgaCountry(String igaCountry) { } - public W8BenEFormRequest igaModel(String igaModel) { + public W8BenEFormRequest igaModel(IgaModelEnum igaModel) { this.igaModel = igaModel; return this; } @@ -1620,11 +2502,11 @@ public W8BenEFormRequest igaModel(String igaModel) { * @return igaModel */ @javax.annotation.Nullable - public String getIgaModel() { + public IgaModelEnum getIgaModel() { return igaModel; } - public void setIgaModel(String igaModel) { + public void setIgaModel(IgaModelEnum igaModel) { this.igaModel = igaModel; } @@ -2773,9 +3655,13 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (!jsonObj.get("entityType").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `entityType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("entityType").toString())); } + // validate the required field `entityType` + EntityTypeEnum.validateJsonElement(jsonObj.get("entityType")); if (!jsonObj.get("fatcaStatus").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `fatcaStatus` to be a primitive type in the JSON string but got `%s`", jsonObj.get("fatcaStatus").toString())); } + // validate the required field `fatcaStatus` + FatcaStatusEnum.validateJsonElement(jsonObj.get("fatcaStatus")); if ((jsonObj.get("residenceAddress") != null && !jsonObj.get("residenceAddress").isJsonNull()) && !jsonObj.get("residenceAddress").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `residenceAddress` to be a primitive type in the JSON string but got `%s`", jsonObj.get("residenceAddress").toString())); } @@ -2785,6 +3671,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("residenceState") != null && !jsonObj.get("residenceState").isJsonNull()) && !jsonObj.get("residenceState").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `residenceState` to be a primitive type in the JSON string but got `%s`", jsonObj.get("residenceState").toString())); } + // validate the optional field `residenceState` + if (jsonObj.get("residenceState") != null && !jsonObj.get("residenceState").isJsonNull()) { + ResidenceStateEnum.validateJsonElement(jsonObj.get("residenceState")); + } if ((jsonObj.get("residenceZip") != null && !jsonObj.get("residenceZip").isJsonNull()) && !jsonObj.get("residenceZip").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `residenceZip` to be a primitive type in the JSON string but got `%s`", jsonObj.get("residenceZip").toString())); } @@ -2800,6 +3690,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("mailingState") != null && !jsonObj.get("mailingState").isJsonNull()) && !jsonObj.get("mailingState").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `mailingState` to be a primitive type in the JSON string but got `%s`", jsonObj.get("mailingState").toString())); } + // validate the optional field `mailingState` + if (jsonObj.get("mailingState") != null && !jsonObj.get("mailingState").isJsonNull()) { + MailingStateEnum.validateJsonElement(jsonObj.get("mailingState")); + } if ((jsonObj.get("mailingZip") != null && !jsonObj.get("mailingZip").isJsonNull()) && !jsonObj.get("mailingZip").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `mailingZip` to be a primitive type in the JSON string but got `%s`", jsonObj.get("mailingZip").toString())); } @@ -2821,6 +3715,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("disregardedEntityFatcaStatus") != null && !jsonObj.get("disregardedEntityFatcaStatus").isJsonNull()) && !jsonObj.get("disregardedEntityFatcaStatus").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `disregardedEntityFatcaStatus` to be a primitive type in the JSON string but got `%s`", jsonObj.get("disregardedEntityFatcaStatus").toString())); } + // validate the optional field `disregardedEntityFatcaStatus` + if (jsonObj.get("disregardedEntityFatcaStatus") != null && !jsonObj.get("disregardedEntityFatcaStatus").isJsonNull()) { + DisregardedEntityFatcaStatusEnum.validateJsonElement(jsonObj.get("disregardedEntityFatcaStatus")); + } if ((jsonObj.get("disregardedAddress") != null && !jsonObj.get("disregardedAddress").isJsonNull()) && !jsonObj.get("disregardedAddress").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `disregardedAddress` to be a primitive type in the JSON string but got `%s`", jsonObj.get("disregardedAddress").toString())); } @@ -2830,6 +3728,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("disregardedState") != null && !jsonObj.get("disregardedState").isJsonNull()) && !jsonObj.get("disregardedState").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `disregardedState` to be a primitive type in the JSON string but got `%s`", jsonObj.get("disregardedState").toString())); } + // validate the optional field `disregardedState` + if (jsonObj.get("disregardedState") != null && !jsonObj.get("disregardedState").isJsonNull()) { + DisregardedStateEnum.validateJsonElement(jsonObj.get("disregardedState")); + } if ((jsonObj.get("disregardedZip") != null && !jsonObj.get("disregardedZip").isJsonNull()) && !jsonObj.get("disregardedZip").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `disregardedZip` to be a primitive type in the JSON string but got `%s`", jsonObj.get("disregardedZip").toString())); } @@ -2845,6 +3747,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("benefitLimitation") != null && !jsonObj.get("benefitLimitation").isJsonNull()) && !jsonObj.get("benefitLimitation").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `benefitLimitation` to be a primitive type in the JSON string but got `%s`", jsonObj.get("benefitLimitation").toString())); } + // validate the optional field `benefitLimitation` + if (jsonObj.get("benefitLimitation") != null && !jsonObj.get("benefitLimitation").isJsonNull()) { + BenefitLimitationEnum.validateJsonElement(jsonObj.get("benefitLimitation")); + } if ((jsonObj.get("treatyArticle") != null && !jsonObj.get("treatyArticle").isJsonNull()) && !jsonObj.get("treatyArticle").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `treatyArticle` to be a primitive type in the JSON string but got `%s`", jsonObj.get("treatyArticle").toString())); } @@ -2869,6 +3775,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("igaModel") != null && !jsonObj.get("igaModel").isJsonNull()) && !jsonObj.get("igaModel").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `igaModel` to be a primitive type in the JSON string but got `%s`", jsonObj.get("igaModel").toString())); } + // validate the optional field `igaModel` + if (jsonObj.get("igaModel") != null && !jsonObj.get("igaModel").isJsonNull()) { + IgaModelEnum.validateJsonElement(jsonObj.get("igaModel")); + } if ((jsonObj.get("igaLegalStatusTreatment") != null && !jsonObj.get("igaLegalStatusTreatment").isJsonNull()) && !jsonObj.get("igaLegalStatusTreatment").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `igaLegalStatusTreatment` to be a primitive type in the JSON string but got `%s`", jsonObj.get("igaLegalStatusTreatment").toString())); } diff --git a/src/main/java/Avalara/SDK/model/A1099/V2/W8BenFormRequest.java b/src/main/java/Avalara/SDK/model/A1099/V2/W8BenFormRequest.java index 33b3f77..3dd8d4a 100644 --- a/src/main/java/Avalara/SDK/model/A1099/V2/W8BenFormRequest.java +++ b/src/main/java/Avalara/SDK/model/A1099/V2/W8BenFormRequest.java @@ -126,77 +126,2729 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_NAME) private String name; + /** + * The country of citizenship.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) + */ + @JsonAdapter(CitizenshipCountryEnum.Adapter.class) + public enum CitizenshipCountryEnum { + US("US"), + + AF("AF"), + + AX("AX"), + + AL("AL"), + + AG("AG"), + + AQ("AQ"), + + AN("AN"), + + AO("AO"), + + AV("AV"), + + AY("AY"), + + AC("AC"), + + AR("AR"), + + AM("AM"), + + AA("AA"), + + AT("AT"), + + AS("AS"), + + AU("AU"), + + AJ("AJ"), + + BF("BF"), + + BA("BA"), + + FQ("FQ"), + + BG("BG"), + + BB("BB"), + + BO("BO"), + + BE("BE"), + + BH("BH"), + + BN("BN"), + + BD("BD"), + + BT("BT"), + + BL("BL"), + + BK("BK"), + + BC("BC"), + + BV("BV"), + + BR("BR"), + + IO("IO"), + + VI("VI"), + + BX("BX"), + + BU("BU"), + + UV("UV"), + + BM("BM"), + + BY("BY"), + + CB("CB"), + + CM("CM"), + + CA("CA"), + + CV("CV"), + + CJ("CJ"), + + CT("CT"), + + CD("CD"), + + CI("CI"), + + CH("CH"), + + KT("KT"), + + IP("IP"), + + CK("CK"), + + CO("CO"), + + CN("CN"), + + CF("CF"), + + CG("CG"), + + CW("CW"), + + CR("CR"), + + CS("CS"), + + IV("IV"), + + HR("HR"), + + CU("CU"), + + UC("UC"), + + CY("CY"), + + EZ("EZ"), + + DA("DA"), + + DX("DX"), + + DJ("DJ"), + + DO("DO"), + + DR("DR"), + + TT("TT"), + + EC("EC"), + + EG("EG"), + + ES("ES"), + + EK("EK"), + + ER("ER"), + + EN("EN"), + + ET("ET"), + + FK("FK"), + + FO("FO"), + + FM("FM"), + + FJ("FJ"), + + FI("FI"), + + FR("FR"), + + FP("FP"), + + FS("FS"), + + GB("GB"), + + GA("GA"), + + GG("GG"), + + GM("GM"), + + GH("GH"), + + GI("GI"), + + GR("GR"), + + GL("GL"), + + GJ("GJ"), + + GQ("GQ"), + + GT("GT"), + + GK("GK"), + + GV("GV"), + + PU("PU"), + + GY("GY"), + + HA("HA"), + + HM("HM"), + + VT("VT"), + + HO("HO"), + + HK("HK"), + + HQ("HQ"), + + HU("HU"), + + IC("IC"), + + IN("IN"), + + ID("ID"), + + IR("IR"), + + IZ("IZ"), + + EI("EI"), + + IS("IS"), + + IT("IT"), + + JM("JM"), + + JN("JN"), + + JA("JA"), + + DQ("DQ"), + + JE("JE"), + + JQ("JQ"), + + JO("JO"), + + KZ("KZ"), + + KE("KE"), + + KQ("KQ"), + + KR("KR"), + + KN("KN"), + + KS("KS"), + + KV("KV"), + + KU("KU"), + + KG("KG"), + + LA("LA"), + + LG("LG"), + + LE("LE"), + + LT("LT"), + + LI("LI"), + + LY("LY"), + + LS("LS"), + + LH("LH"), + + LU("LU"), + + MC("MC"), + + MK("MK"), + + MA("MA"), + + MI("MI"), + + MY("MY"), + + MV("MV"), + + ML("ML"), + + MT("MT"), + + IM("IM"), + + RM("RM"), + + MR("MR"), + + MP("MP"), + + MX("MX"), + + MQ("MQ"), + + MD("MD"), + + MN("MN"), + + MG("MG"), + + MJ("MJ"), + + MH("MH"), + + MO("MO"), + + MZ("MZ"), + + WA("WA"), + + NR("NR"), + + BQ("BQ"), + + NP("NP"), + + NL("NL"), + + NC("NC"), + + NZ("NZ"), + + NU("NU"), + + NG("NG"), + + NI("NI"), + + NE("NE"), + + NF("NF"), + + CQ("CQ"), + + NO("NO"), + + MU("MU"), + + OC("OC"), + + PK("PK"), + + PS("PS"), + + LQ("LQ"), + + PM("PM"), + + PP("PP"), + + PF("PF"), + + PA("PA"), + + PE("PE"), + + RP("RP"), + + PC("PC"), + + PL("PL"), + + PO("PO"), + + RQ("RQ"), + + QA("QA"), + + RO("RO"), + + RS("RS"), + + RW("RW"), + + TB("TB"), + + RN("RN"), + + WS("WS"), + + SM("SM"), + + TP("TP"), + + SA("SA"), + + SG("SG"), + + RI("RI"), + + SE("SE"), + + SL("SL"), + + SN("SN"), + + NN("NN"), + + LO("LO"), + + SI("SI"), + + BP("BP"), + + SO("SO"), + + SF("SF"), + + SX("SX"), + + SP("SP"), + + PG("PG"), + + CE("CE"), + + SH("SH"), + + SC("SC"), + + ST("ST"), + + SB("SB"), + + VC("VC"), + + SU("SU"), + + NS("NS"), + + SV("SV"), + + WZ("WZ"), + + SW("SW"), + + SZ("SZ"), + + SY("SY"), + + TW("TW"), + + TI("TI"), + + TZ("TZ"), + + TH("TH"), + + TO("TO"), + + TL("TL"), + + TN("TN"), + + TD("TD"), + + TS("TS"), + + TU("TU"), + + TX("TX"), + + TK("TK"), + + TV("TV"), + + UG("UG"), + + UP("UP"), + + AE("AE"), + + UK("UK"), + + UY("UY"), + + UZ("UZ"), + + NH("NH"), + + VE("VE"), + + VM("VM"), + + VQ("VQ"), + + WQ("WQ"), + + WF("WF"), + + WI("WI"), + + YM("YM"), + + ZA("ZA"), + + ZI("ZI"); + + private String value; + + CitizenshipCountryEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static CitizenshipCountryEnum fromValue(String value) { + for (CitizenshipCountryEnum b : CitizenshipCountryEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final CitizenshipCountryEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public CitizenshipCountryEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return CitizenshipCountryEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + CitizenshipCountryEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_CITIZENSHIP_COUNTRY = "citizenshipCountry"; @SerializedName(SERIALIZED_NAME_CITIZENSHIP_COUNTRY) - private String citizenshipCountry; + private CitizenshipCountryEnum citizenshipCountry; + + public static final String SERIALIZED_NAME_RESIDENCE_ADDRESS = "residenceAddress"; + @SerializedName(SERIALIZED_NAME_RESIDENCE_ADDRESS) + private String residenceAddress; + + public static final String SERIALIZED_NAME_RESIDENCE_CITY = "residenceCity"; + @SerializedName(SERIALIZED_NAME_RESIDENCE_CITY) + private String residenceCity; + + /** + * The state of residence. Required for US and Canada.. Allowed values: AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO (and 65 more) + */ + @JsonAdapter(ResidenceStateEnum.Adapter.class) + public enum ResidenceStateEnum { + AA("AA"), + + AE("AE"), + + AK("AK"), + + AL("AL"), + + AP("AP"), + + AR("AR"), + + AS("AS"), + + AZ("AZ"), + + CA("CA"), + + CO("CO"), + + CT("CT"), + + DC("DC"), + + DE("DE"), + + FL("FL"), + + FM("FM"), + + GA("GA"), + + GU("GU"), + + HI("HI"), + + IA("IA"), + + ID("ID"), + + IL("IL"), + + IN("IN"), + + KS("KS"), + + KY("KY"), + + LA("LA"), + + MA("MA"), + + MD("MD"), + + ME("ME"), + + MH("MH"), + + MI("MI"), + + MN("MN"), + + MO("MO"), + + MP("MP"), + + MS("MS"), + + MT("MT"), + + NC("NC"), + + ND("ND"), + + NE("NE"), + + NH("NH"), + + NJ("NJ"), + + NM("NM"), + + NV("NV"), + + NY("NY"), + + OH("OH"), + + OK("OK"), + + OR("OR"), + + PA("PA"), + + PR("PR"), + + PW("PW"), + + RI("RI"), + + SC("SC"), + + SD("SD"), + + TN("TN"), + + TX("TX"), + + UT("UT"), + + VA("VA"), + + VI("VI"), + + VT("VT"), + + WA("WA"), + + WI("WI"), + + WV("WV"), + + WY("WY"), + + AB("AB"), + + BC("BC"), + + MB("MB"), + + NB("NB"), + + NL("NL"), + + NS("NS"), + + NT("NT"), + + NU("NU"), + + ON("ON"), + + PE("PE"), + + QC("QC"), + + SK("SK"), + + YT("YT"); + + private String value; + + ResidenceStateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ResidenceStateEnum fromValue(String value) { + for (ResidenceStateEnum b : ResidenceStateEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ResidenceStateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ResidenceStateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ResidenceStateEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + ResidenceStateEnum.fromValue(value); + } + } + + public static final String SERIALIZED_NAME_RESIDENCE_STATE = "residenceState"; + @SerializedName(SERIALIZED_NAME_RESIDENCE_STATE) + private ResidenceStateEnum residenceState; + + public static final String SERIALIZED_NAME_RESIDENCE_ZIP = "residenceZip"; + @SerializedName(SERIALIZED_NAME_RESIDENCE_ZIP) + private String residenceZip; + + /** + * The country of residence.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) + */ + @JsonAdapter(ResidenceCountryEnum.Adapter.class) + public enum ResidenceCountryEnum { + US("US"), + + AF("AF"), + + AX("AX"), + + AL("AL"), + + AG("AG"), + + AQ("AQ"), + + AN("AN"), + + AO("AO"), + + AV("AV"), + + AY("AY"), + + AC("AC"), + + AR("AR"), + + AM("AM"), + + AA("AA"), + + AT("AT"), + + AS("AS"), + + AU("AU"), + + AJ("AJ"), + + BF("BF"), + + BA("BA"), + + FQ("FQ"), + + BG("BG"), + + BB("BB"), + + BO("BO"), + + BE("BE"), + + BH("BH"), + + BN("BN"), + + BD("BD"), + + BT("BT"), + + BL("BL"), + + BK("BK"), + + BC("BC"), + + BV("BV"), + + BR("BR"), + + IO("IO"), + + VI("VI"), + + BX("BX"), + + BU("BU"), + + UV("UV"), + + BM("BM"), + + BY("BY"), + + CB("CB"), + + CM("CM"), + + CA("CA"), + + CV("CV"), + + CJ("CJ"), + + CT("CT"), + + CD("CD"), + + CI("CI"), + + CH("CH"), + + KT("KT"), + + IP("IP"), + + CK("CK"), + + CO("CO"), + + CN("CN"), + + CF("CF"), + + CG("CG"), + + CW("CW"), + + CR("CR"), + + CS("CS"), + + IV("IV"), + + HR("HR"), + + CU("CU"), + + UC("UC"), + + CY("CY"), + + EZ("EZ"), + + DA("DA"), + + DX("DX"), + + DJ("DJ"), + + DO("DO"), + + DR("DR"), + + TT("TT"), + + EC("EC"), + + EG("EG"), + + ES("ES"), + + EK("EK"), + + ER("ER"), + + EN("EN"), + + ET("ET"), + + FK("FK"), + + FO("FO"), + + FM("FM"), + + FJ("FJ"), + + FI("FI"), + + FR("FR"), + + FP("FP"), + + FS("FS"), + + GB("GB"), + + GA("GA"), + + GG("GG"), + + GM("GM"), + + GH("GH"), + + GI("GI"), + + GR("GR"), + + GL("GL"), + + GJ("GJ"), + + GQ("GQ"), + + GT("GT"), + + GK("GK"), + + GV("GV"), + + PU("PU"), + + GY("GY"), + + HA("HA"), + + HM("HM"), + + VT("VT"), + + HO("HO"), + + HK("HK"), + + HQ("HQ"), + + HU("HU"), + + IC("IC"), + + IN("IN"), + + ID("ID"), + + IR("IR"), + + IZ("IZ"), + + EI("EI"), + + IS("IS"), + + IT("IT"), + + JM("JM"), + + JN("JN"), + + JA("JA"), + + DQ("DQ"), + + JE("JE"), + + JQ("JQ"), + + JO("JO"), + + KZ("KZ"), + + KE("KE"), + + KQ("KQ"), + + KR("KR"), + + KN("KN"), + + KS("KS"), + + KV("KV"), + + KU("KU"), + + KG("KG"), + + LA("LA"), + + LG("LG"), + + LE("LE"), + + LT("LT"), + + LI("LI"), + + LY("LY"), + + LS("LS"), + + LH("LH"), + + LU("LU"), + + MC("MC"), + + MK("MK"), + + MA("MA"), + + MI("MI"), + + MY("MY"), + + MV("MV"), + + ML("ML"), + + MT("MT"), + + IM("IM"), + + RM("RM"), + + MR("MR"), + + MP("MP"), + + MX("MX"), + + MQ("MQ"), + + MD("MD"), + + MN("MN"), + + MG("MG"), + + MJ("MJ"), + + MH("MH"), + + MO("MO"), + + MZ("MZ"), + + WA("WA"), + + NR("NR"), + + BQ("BQ"), + + NP("NP"), + + NL("NL"), + + NC("NC"), + + NZ("NZ"), + + NU("NU"), + + NG("NG"), + + NI("NI"), + + NE("NE"), + + NF("NF"), + + CQ("CQ"), + + NO("NO"), + + MU("MU"), + + OC("OC"), + + PK("PK"), + + PS("PS"), + + LQ("LQ"), + + PM("PM"), + + PP("PP"), + + PF("PF"), + + PA("PA"), + + PE("PE"), + + RP("RP"), + + PC("PC"), + + PL("PL"), + + PO("PO"), + + RQ("RQ"), + + QA("QA"), + + RO("RO"), + + RS("RS"), + + RW("RW"), + + TB("TB"), + + RN("RN"), + + WS("WS"), + + SM("SM"), + + TP("TP"), + + SA("SA"), + + SG("SG"), + + RI("RI"), + + SE("SE"), + + SL("SL"), + + SN("SN"), + + NN("NN"), + + LO("LO"), + + SI("SI"), + + BP("BP"), + + SO("SO"), + + SF("SF"), + + SX("SX"), + + SP("SP"), + + PG("PG"), + + CE("CE"), + + SH("SH"), + + SC("SC"), + + ST("ST"), + + SB("SB"), + + VC("VC"), + + SU("SU"), + + NS("NS"), + + SV("SV"), + + WZ("WZ"), + + SW("SW"), + + SZ("SZ"), + + SY("SY"), + + TW("TW"), + + TI("TI"), + + TZ("TZ"), + + TH("TH"), + + TO("TO"), + + TL("TL"), + + TN("TN"), + + TD("TD"), + + TS("TS"), + + TU("TU"), + + TX("TX"), + + TK("TK"), + + TV("TV"), + + UG("UG"), + + UP("UP"), + + AE("AE"), + + UK("UK"), + + UY("UY"), + + UZ("UZ"), + + NH("NH"), + + VE("VE"), + + VM("VM"), + + VQ("VQ"), + + WQ("WQ"), + + WF("WF"), + + WI("WI"), + + YM("YM"), + + ZA("ZA"), + + ZI("ZI"); + + private String value; + + ResidenceCountryEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ResidenceCountryEnum fromValue(String value) { + for (ResidenceCountryEnum b : ResidenceCountryEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ResidenceCountryEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ResidenceCountryEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ResidenceCountryEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + ResidenceCountryEnum.fromValue(value); + } + } + + public static final String SERIALIZED_NAME_RESIDENCE_COUNTRY = "residenceCountry"; + @SerializedName(SERIALIZED_NAME_RESIDENCE_COUNTRY) + private ResidenceCountryEnum residenceCountry; + + public static final String SERIALIZED_NAME_RESIDENCE_IS_MAILING = "residenceIsMailing"; + @SerializedName(SERIALIZED_NAME_RESIDENCE_IS_MAILING) + private Boolean residenceIsMailing; + + public static final String SERIALIZED_NAME_MAILING_ADDRESS = "mailingAddress"; + @SerializedName(SERIALIZED_NAME_MAILING_ADDRESS) + private String mailingAddress; + + public static final String SERIALIZED_NAME_MAILING_CITY = "mailingCity"; + @SerializedName(SERIALIZED_NAME_MAILING_CITY) + private String mailingCity; + + /** + * 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) + */ + @JsonAdapter(MailingStateEnum.Adapter.class) + public enum MailingStateEnum { + AA("AA"), + + AE("AE"), + + AK("AK"), + + AL("AL"), + + AP("AP"), + + AR("AR"), + + AS("AS"), + + AZ("AZ"), + + CA("CA"), + + CO("CO"), + + CT("CT"), + + DC("DC"), + + DE("DE"), + + FL("FL"), + + FM("FM"), + + GA("GA"), + + GU("GU"), + + HI("HI"), + + IA("IA"), + + ID("ID"), + + IL("IL"), + + IN("IN"), + + KS("KS"), + + KY("KY"), + + LA("LA"), + + MA("MA"), + + MD("MD"), + + ME("ME"), + + MH("MH"), + + MI("MI"), + + MN("MN"), + + MO("MO"), + + MP("MP"), + + MS("MS"), + + MT("MT"), + + NC("NC"), + + ND("ND"), + + NE("NE"), + + NH("NH"), + + NJ("NJ"), + + NM("NM"), + + NV("NV"), + + NY("NY"), + + OH("OH"), + + OK("OK"), + + OR("OR"), + + PA("PA"), + + PR("PR"), + + PW("PW"), + + RI("RI"), + + SC("SC"), + + SD("SD"), + + TN("TN"), + + TX("TX"), + + UT("UT"), + + VA("VA"), + + VI("VI"), + + VT("VT"), + + WA("WA"), + + WI("WI"), + + WV("WV"), + + WY("WY"), + + AB("AB"), + + BC("BC"), + + MB("MB"), + + NB("NB"), + + NL("NL"), + + NS("NS"), + + NT("NT"), + + NU("NU"), + + ON("ON"), + + PE("PE"), + + QC("QC"), + + SK("SK"), + + YT("YT"); + + private String value; + + MailingStateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static MailingStateEnum fromValue(String value) { + for (MailingStateEnum b : MailingStateEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final MailingStateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public MailingStateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return MailingStateEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + MailingStateEnum.fromValue(value); + } + } + + public static final String SERIALIZED_NAME_MAILING_STATE = "mailingState"; + @SerializedName(SERIALIZED_NAME_MAILING_STATE) + private MailingStateEnum mailingState; + + public static final String SERIALIZED_NAME_MAILING_ZIP = "mailingZip"; + @SerializedName(SERIALIZED_NAME_MAILING_ZIP) + private String mailingZip; + + /** + * The country of the mailing address.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) + */ + @JsonAdapter(MailingCountryEnum.Adapter.class) + public enum MailingCountryEnum { + US("US"), + + AF("AF"), + + AX("AX"), + + AL("AL"), + + AG("AG"), + + AQ("AQ"), + + AN("AN"), + + AO("AO"), + + AV("AV"), + + AY("AY"), + + AC("AC"), + + AR("AR"), + + AM("AM"), + + AA("AA"), + + AT("AT"), + + AS("AS"), + + AU("AU"), + + AJ("AJ"), + + BF("BF"), + + BA("BA"), + + FQ("FQ"), + + BG("BG"), + + BB("BB"), + + BO("BO"), + + BE("BE"), + + BH("BH"), + + BN("BN"), + + BD("BD"), + + BT("BT"), + + BL("BL"), + + BK("BK"), + + BC("BC"), + + BV("BV"), + + BR("BR"), + + IO("IO"), + + VI("VI"), + + BX("BX"), + + BU("BU"), + + UV("UV"), + + BM("BM"), + + BY("BY"), + + CB("CB"), + + CM("CM"), + + CA("CA"), + + CV("CV"), + + CJ("CJ"), + + CT("CT"), + + CD("CD"), + + CI("CI"), + + CH("CH"), + + KT("KT"), + + IP("IP"), + + CK("CK"), + + CO("CO"), + + CN("CN"), + + CF("CF"), + + CG("CG"), + + CW("CW"), + + CR("CR"), + + CS("CS"), + + IV("IV"), + + HR("HR"), + + CU("CU"), + + UC("UC"), + + CY("CY"), + + EZ("EZ"), + + DA("DA"), + + DX("DX"), + + DJ("DJ"), + + DO("DO"), + + DR("DR"), + + TT("TT"), + + EC("EC"), + + EG("EG"), + + ES("ES"), + + EK("EK"), + + ER("ER"), + + EN("EN"), + + ET("ET"), + + FK("FK"), + + FO("FO"), + + FM("FM"), + + FJ("FJ"), + + FI("FI"), + + FR("FR"), + + FP("FP"), + + FS("FS"), + + GB("GB"), + + GA("GA"), + + GG("GG"), + + GM("GM"), + + GH("GH"), + + GI("GI"), + + GR("GR"), + + GL("GL"), + + GJ("GJ"), + + GQ("GQ"), + + GT("GT"), + + GK("GK"), + + GV("GV"), + + PU("PU"), + + GY("GY"), + + HA("HA"), + + HM("HM"), + + VT("VT"), + + HO("HO"), + + HK("HK"), + + HQ("HQ"), + + HU("HU"), + + IC("IC"), + + IN("IN"), + + ID("ID"), + + IR("IR"), + + IZ("IZ"), + + EI("EI"), + + IS("IS"), + + IT("IT"), + + JM("JM"), + + JN("JN"), + + JA("JA"), + + DQ("DQ"), + + JE("JE"), + + JQ("JQ"), + + JO("JO"), + + KZ("KZ"), + + KE("KE"), + + KQ("KQ"), + + KR("KR"), + + KN("KN"), + + KS("KS"), + + KV("KV"), + + KU("KU"), + + KG("KG"), + + LA("LA"), + + LG("LG"), + + LE("LE"), + + LT("LT"), + + LI("LI"), + + LY("LY"), + + LS("LS"), + + LH("LH"), + + LU("LU"), + + MC("MC"), + + MK("MK"), + + MA("MA"), + + MI("MI"), + + MY("MY"), + + MV("MV"), + + ML("ML"), + + MT("MT"), + + IM("IM"), + + RM("RM"), + + MR("MR"), + + MP("MP"), + + MX("MX"), + + MQ("MQ"), + + MD("MD"), + + MN("MN"), + + MG("MG"), + + MJ("MJ"), + + MH("MH"), + + MO("MO"), + + MZ("MZ"), + + WA("WA"), + + NR("NR"), + + BQ("BQ"), + + NP("NP"), + + NL("NL"), + + NC("NC"), + + NZ("NZ"), + + NU("NU"), + + NG("NG"), + + NI("NI"), + + NE("NE"), + + NF("NF"), + + CQ("CQ"), + + NO("NO"), + + MU("MU"), + + OC("OC"), + + PK("PK"), + + PS("PS"), + + LQ("LQ"), + + PM("PM"), + + PP("PP"), + + PF("PF"), + + PA("PA"), + + PE("PE"), + + RP("RP"), + + PC("PC"), + + PL("PL"), + + PO("PO"), + + RQ("RQ"), + + QA("QA"), + + RO("RO"), + + RS("RS"), + + RW("RW"), + + TB("TB"), + + RN("RN"), + + WS("WS"), + + SM("SM"), + + TP("TP"), + + SA("SA"), + + SG("SG"), + + RI("RI"), + + SE("SE"), + + SL("SL"), + + SN("SN"), + + NN("NN"), + + LO("LO"), + + SI("SI"), + + BP("BP"), + + SO("SO"), + + SF("SF"), + + SX("SX"), + + SP("SP"), + + PG("PG"), + + CE("CE"), + + SH("SH"), + + SC("SC"), + + ST("ST"), + + SB("SB"), + + VC("VC"), + + SU("SU"), + + NS("NS"), + + SV("SV"), + + WZ("WZ"), + + SW("SW"), + + SZ("SZ"), + + SY("SY"), + + TW("TW"), + + TI("TI"), + + TZ("TZ"), + + TH("TH"), + + TO("TO"), + + TL("TL"), + + TN("TN"), + + TD("TD"), + + TS("TS"), + + TU("TU"), + + TX("TX"), + + TK("TK"), + + TV("TV"), + + UG("UG"), + + UP("UP"), + + AE("AE"), + + UK("UK"), + + UY("UY"), + + UZ("UZ"), + + NH("NH"), + + VE("VE"), + + VM("VM"), + + VQ("VQ"), + + WQ("WQ"), + + WF("WF"), + + WI("WI"), + + YM("YM"), + + ZA("ZA"), + + ZI("ZI"); - public static final String SERIALIZED_NAME_RESIDENCE_ADDRESS = "residenceAddress"; - @SerializedName(SERIALIZED_NAME_RESIDENCE_ADDRESS) - private String residenceAddress; + private String value; - public static final String SERIALIZED_NAME_RESIDENCE_CITY = "residenceCity"; - @SerializedName(SERIALIZED_NAME_RESIDENCE_CITY) - private String residenceCity; + MailingCountryEnum(String value) { + this.value = value; + } - public static final String SERIALIZED_NAME_RESIDENCE_STATE = "residenceState"; - @SerializedName(SERIALIZED_NAME_RESIDENCE_STATE) - private String residenceState; + public String getValue() { + return value; + } - public static final String SERIALIZED_NAME_RESIDENCE_ZIP = "residenceZip"; - @SerializedName(SERIALIZED_NAME_RESIDENCE_ZIP) - private String residenceZip; + @Override + public String toString() { + return String.valueOf(value); + } - public static final String SERIALIZED_NAME_RESIDENCE_COUNTRY = "residenceCountry"; - @SerializedName(SERIALIZED_NAME_RESIDENCE_COUNTRY) - private String residenceCountry; + public static MailingCountryEnum fromValue(String value) { + for (MailingCountryEnum b : MailingCountryEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } - public static final String SERIALIZED_NAME_RESIDENCE_IS_MAILING = "residenceIsMailing"; - @SerializedName(SERIALIZED_NAME_RESIDENCE_IS_MAILING) - private Boolean residenceIsMailing; + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final MailingCountryEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } - public static final String SERIALIZED_NAME_MAILING_ADDRESS = "mailingAddress"; - @SerializedName(SERIALIZED_NAME_MAILING_ADDRESS) - private String mailingAddress; + @Override + public MailingCountryEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return MailingCountryEnum.fromValue(value); + } + } - public static final String SERIALIZED_NAME_MAILING_CITY = "mailingCity"; - @SerializedName(SERIALIZED_NAME_MAILING_CITY) - private String mailingCity; + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + MailingCountryEnum.fromValue(value); + } + } + + public static final String SERIALIZED_NAME_MAILING_COUNTRY = "mailingCountry"; + @SerializedName(SERIALIZED_NAME_MAILING_COUNTRY) + private MailingCountryEnum mailingCountry; + + public static final String SERIALIZED_NAME_TIN = "tin"; + @SerializedName(SERIALIZED_NAME_TIN) + private String tin; + + public static final String SERIALIZED_NAME_FOREIGN_TIN_NOT_REQUIRED = "foreignTinNotRequired"; + @SerializedName(SERIALIZED_NAME_FOREIGN_TIN_NOT_REQUIRED) + private Boolean foreignTinNotRequired; + + public static final String SERIALIZED_NAME_FOREIGN_TIN = "foreignTin"; + @SerializedName(SERIALIZED_NAME_FOREIGN_TIN) + private String foreignTin; + + public static final String SERIALIZED_NAME_REFERENCE_NUMBER = "referenceNumber"; + @SerializedName(SERIALIZED_NAME_REFERENCE_NUMBER) + private String referenceNumber; + + public static final String SERIALIZED_NAME_BIRTHDAY = "birthday"; + @SerializedName(SERIALIZED_NAME_BIRTHDAY) + private LocalDate birthday; + + /** + * The country for which the treaty applies.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) + */ + @JsonAdapter(TreatyCountryEnum.Adapter.class) + public enum TreatyCountryEnum { + US("US"), + + AF("AF"), + + AX("AX"), + + AL("AL"), + + AG("AG"), + + AQ("AQ"), + + AN("AN"), + + AO("AO"), + + AV("AV"), + + AY("AY"), + + AC("AC"), + + AR("AR"), + + AM("AM"), + + AA("AA"), + + AT("AT"), + + AS("AS"), + + AU("AU"), + + AJ("AJ"), + + BF("BF"), + + BA("BA"), + + FQ("FQ"), + + BG("BG"), + + BB("BB"), + + BO("BO"), + + BE("BE"), + + BH("BH"), + + BN("BN"), + + BD("BD"), + + BT("BT"), + + BL("BL"), + + BK("BK"), + + BC("BC"), + + BV("BV"), + + BR("BR"), + + IO("IO"), + + VI("VI"), + + BX("BX"), + + BU("BU"), + + UV("UV"), + + BM("BM"), + + BY("BY"), + + CB("CB"), + + CM("CM"), + + CA("CA"), + + CV("CV"), + + CJ("CJ"), + + CT("CT"), + + CD("CD"), + + CI("CI"), + + CH("CH"), + + KT("KT"), + + IP("IP"), + + CK("CK"), + + CO("CO"), + + CN("CN"), + + CF("CF"), + + CG("CG"), + + CW("CW"), + + CR("CR"), + + CS("CS"), + + IV("IV"), + + HR("HR"), + + CU("CU"), + + UC("UC"), + + CY("CY"), + + EZ("EZ"), + + DA("DA"), + + DX("DX"), + + DJ("DJ"), + + DO("DO"), + + DR("DR"), + + TT("TT"), + + EC("EC"), + + EG("EG"), + + ES("ES"), + + EK("EK"), + + ER("ER"), + + EN("EN"), + + ET("ET"), + + FK("FK"), + + FO("FO"), + + FM("FM"), + + FJ("FJ"), + + FI("FI"), + + FR("FR"), + + FP("FP"), + + FS("FS"), + + GB("GB"), + + GA("GA"), + + GG("GG"), + + GM("GM"), + + GH("GH"), + + GI("GI"), + + GR("GR"), + + GL("GL"), + + GJ("GJ"), + + GQ("GQ"), + + GT("GT"), + + GK("GK"), + + GV("GV"), + + PU("PU"), + + GY("GY"), + + HA("HA"), + + HM("HM"), + + VT("VT"), + + HO("HO"), + + HK("HK"), + + HQ("HQ"), + + HU("HU"), + + IC("IC"), + + IN("IN"), + + ID("ID"), + + IR("IR"), + + IZ("IZ"), + + EI("EI"), + + IS("IS"), + + IT("IT"), + + JM("JM"), + + JN("JN"), + + JA("JA"), + + DQ("DQ"), + + JE("JE"), + + JQ("JQ"), + + JO("JO"), + + KZ("KZ"), + + KE("KE"), + + KQ("KQ"), + + KR("KR"), + + KN("KN"), + + KS("KS"), + + KV("KV"), + + KU("KU"), + + KG("KG"), + + LA("LA"), + + LG("LG"), + + LE("LE"), + + LT("LT"), + + LI("LI"), + + LY("LY"), + + LS("LS"), + + LH("LH"), + + LU("LU"), + + MC("MC"), + + MK("MK"), + + MA("MA"), + + MI("MI"), + + MY("MY"), + + MV("MV"), + + ML("ML"), + + MT("MT"), + + IM("IM"), + + RM("RM"), + + MR("MR"), + + MP("MP"), + + MX("MX"), + + MQ("MQ"), + + MD("MD"), + + MN("MN"), + + MG("MG"), + + MJ("MJ"), + + MH("MH"), + + MO("MO"), + + MZ("MZ"), + + WA("WA"), + + NR("NR"), + + BQ("BQ"), + + NP("NP"), + + NL("NL"), + + NC("NC"), + + NZ("NZ"), + + NU("NU"), + + NG("NG"), + + NI("NI"), + + NE("NE"), + + NF("NF"), + + CQ("CQ"), + + NO("NO"), + + MU("MU"), + + OC("OC"), + + PK("PK"), + + PS("PS"), + + LQ("LQ"), + + PM("PM"), + + PP("PP"), + + PF("PF"), + + PA("PA"), + + PE("PE"), + + RP("RP"), + + PC("PC"), + + PL("PL"), + + PO("PO"), + + RQ("RQ"), + + QA("QA"), + + RO("RO"), + + RS("RS"), + + RW("RW"), + + TB("TB"), + + RN("RN"), + + WS("WS"), + + SM("SM"), + + TP("TP"), + + SA("SA"), + + SG("SG"), + + RI("RI"), + + SE("SE"), + + SL("SL"), + + SN("SN"), + + NN("NN"), + + LO("LO"), + + SI("SI"), + + BP("BP"), + + SO("SO"), + + SF("SF"), + + SX("SX"), + + SP("SP"), + + PG("PG"), + + CE("CE"), + + SH("SH"), + + SC("SC"), + + ST("ST"), + + SB("SB"), + + VC("VC"), + + SU("SU"), + + NS("NS"), + + SV("SV"), + + WZ("WZ"), + + SW("SW"), + + SZ("SZ"), + + SY("SY"), + + TW("TW"), + + TI("TI"), + + TZ("TZ"), + + TH("TH"), + + TO("TO"), + + TL("TL"), + + TN("TN"), + + TD("TD"), + + TS("TS"), + + TU("TU"), + + TX("TX"), + + TK("TK"), + + TV("TV"), + + UG("UG"), + + UP("UP"), + + AE("AE"), + + UK("UK"), + + UY("UY"), + + UZ("UZ"), + + NH("NH"), + + VE("VE"), + + VM("VM"), + + VQ("VQ"), + + WQ("WQ"), + + WF("WF"), + + WI("WI"), + + YM("YM"), + + ZA("ZA"), + + ZI("ZI"); - public static final String SERIALIZED_NAME_MAILING_STATE = "mailingState"; - @SerializedName(SERIALIZED_NAME_MAILING_STATE) - private String mailingState; + private String value; - public static final String SERIALIZED_NAME_MAILING_ZIP = "mailingZip"; - @SerializedName(SERIALIZED_NAME_MAILING_ZIP) - private String mailingZip; + TreatyCountryEnum(String value) { + this.value = value; + } - public static final String SERIALIZED_NAME_MAILING_COUNTRY = "mailingCountry"; - @SerializedName(SERIALIZED_NAME_MAILING_COUNTRY) - private String mailingCountry; + public String getValue() { + return value; + } - public static final String SERIALIZED_NAME_TIN = "tin"; - @SerializedName(SERIALIZED_NAME_TIN) - private String tin; + @Override + public String toString() { + return String.valueOf(value); + } - public static final String SERIALIZED_NAME_FOREIGN_TIN_NOT_REQUIRED = "foreignTinNotRequired"; - @SerializedName(SERIALIZED_NAME_FOREIGN_TIN_NOT_REQUIRED) - private Boolean foreignTinNotRequired; + public static TreatyCountryEnum fromValue(String value) { + for (TreatyCountryEnum b : TreatyCountryEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } - public static final String SERIALIZED_NAME_FOREIGN_TIN = "foreignTin"; - @SerializedName(SERIALIZED_NAME_FOREIGN_TIN) - private String foreignTin; + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TreatyCountryEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } - public static final String SERIALIZED_NAME_REFERENCE_NUMBER = "referenceNumber"; - @SerializedName(SERIALIZED_NAME_REFERENCE_NUMBER) - private String referenceNumber; + @Override + public TreatyCountryEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TreatyCountryEnum.fromValue(value); + } + } - public static final String SERIALIZED_NAME_BIRTHDAY = "birthday"; - @SerializedName(SERIALIZED_NAME_BIRTHDAY) - private LocalDate birthday; + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + TreatyCountryEnum.fromValue(value); + } + } public static final String SERIALIZED_NAME_TREATY_COUNTRY = "treatyCountry"; @SerializedName(SERIALIZED_NAME_TREATY_COUNTRY) - private String treatyCountry; + private TreatyCountryEnum treatyCountry; public static final String SERIALIZED_NAME_TREATY_ARTICLE = "treatyArticle"; @SerializedName(SERIALIZED_NAME_TREATY_ARTICLE) @@ -206,9 +2858,79 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_TREATY_REASONS) private String treatyReasons; + /** + * 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) + */ + @JsonAdapter(WithholdingRateEnum.Adapter.class) + public enum WithholdingRateEnum { + _0("0"), + + _0_0("0.0"), + + _0_00("0.00"), + + _5("5"), + + _5_5("5.5"), + + _10("10"), + + _12_50("12.50"), + + _15("15"), + + _20("20"), + + _25("25"), + + _30("30"); + + private String value; + + WithholdingRateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static WithholdingRateEnum fromValue(String value) { + for (WithholdingRateEnum b : WithholdingRateEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final WithholdingRateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public WithholdingRateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return WithholdingRateEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + WithholdingRateEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_WITHHOLDING_RATE = "withholdingRate"; @SerializedName(SERIALIZED_NAME_WITHHOLDING_RATE) - private String withholdingRate; + private WithholdingRateEnum withholdingRate; public static final String SERIALIZED_NAME_INCOME_TYPE = "incomeType"; @SerializedName(SERIALIZED_NAME_INCOME_TYPE) @@ -278,21 +3000,21 @@ public void setName(String name) { } - public W8BenFormRequest citizenshipCountry(String citizenshipCountry) { + public W8BenFormRequest citizenshipCountry(CitizenshipCountryEnum citizenshipCountry) { this.citizenshipCountry = citizenshipCountry; return this; } /** - * The country of citizenship. + * The country of citizenship.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) * @return citizenshipCountry */ @javax.annotation.Nonnull - public String getCitizenshipCountry() { + public CitizenshipCountryEnum getCitizenshipCountry() { return citizenshipCountry; } - public void setCitizenshipCountry(String citizenshipCountry) { + public void setCitizenshipCountry(CitizenshipCountryEnum citizenshipCountry) { this.citizenshipCountry = citizenshipCountry; } @@ -335,21 +3057,21 @@ public void setResidenceCity(String residenceCity) { } - public W8BenFormRequest residenceState(String residenceState) { + public W8BenFormRequest residenceState(ResidenceStateEnum residenceState) { this.residenceState = residenceState; return this; } /** - * The state of residence. + * The state of residence. Required for US and Canada.. Allowed values: AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO (and 65 more) * @return residenceState */ @javax.annotation.Nullable - public String getResidenceState() { + public ResidenceStateEnum getResidenceState() { return residenceState; } - public void setResidenceState(String residenceState) { + public void setResidenceState(ResidenceStateEnum residenceState) { this.residenceState = residenceState; } @@ -373,21 +3095,21 @@ public void setResidenceZip(String residenceZip) { } - public W8BenFormRequest residenceCountry(String residenceCountry) { + public W8BenFormRequest residenceCountry(ResidenceCountryEnum residenceCountry) { this.residenceCountry = residenceCountry; return this; } /** - * The country of residence. + * The country of residence.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) * @return residenceCountry */ @javax.annotation.Nonnull - public String getResidenceCountry() { + public ResidenceCountryEnum getResidenceCountry() { return residenceCountry; } - public void setResidenceCountry(String residenceCountry) { + public void setResidenceCountry(ResidenceCountryEnum residenceCountry) { this.residenceCountry = residenceCountry; } @@ -449,21 +3171,21 @@ public void setMailingCity(String mailingCity) { } - public W8BenFormRequest mailingState(String mailingState) { + public W8BenFormRequest mailingState(MailingStateEnum mailingState) { this.mailingState = mailingState; return this; } /** - * The state of the mailing address. + * 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) * @return mailingState */ @javax.annotation.Nullable - public String getMailingState() { + public MailingStateEnum getMailingState() { return mailingState; } - public void setMailingState(String mailingState) { + public void setMailingState(MailingStateEnum mailingState) { this.mailingState = mailingState; } @@ -487,21 +3209,21 @@ public void setMailingZip(String mailingZip) { } - public W8BenFormRequest mailingCountry(String mailingCountry) { + public W8BenFormRequest mailingCountry(MailingCountryEnum mailingCountry) { this.mailingCountry = mailingCountry; return this; } /** - * The country of the mailing address. + * The country of the mailing address.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) * @return mailingCountry */ @javax.annotation.Nullable - public String getMailingCountry() { + public MailingCountryEnum getMailingCountry() { return mailingCountry; } - public void setMailingCountry(String mailingCountry) { + public void setMailingCountry(MailingCountryEnum mailingCountry) { this.mailingCountry = mailingCountry; } @@ -601,21 +3323,21 @@ public void setBirthday(LocalDate birthday) { } - public W8BenFormRequest treatyCountry(String treatyCountry) { + public W8BenFormRequest treatyCountry(TreatyCountryEnum treatyCountry) { this.treatyCountry = treatyCountry; return this; } /** - * The country for which the treaty applies. + * The country for which the treaty applies.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) * @return treatyCountry */ @javax.annotation.Nullable - public String getTreatyCountry() { + public TreatyCountryEnum getTreatyCountry() { return treatyCountry; } - public void setTreatyCountry(String treatyCountry) { + public void setTreatyCountry(TreatyCountryEnum treatyCountry) { this.treatyCountry = treatyCountry; } @@ -658,21 +3380,21 @@ public void setTreatyReasons(String treatyReasons) { } - public W8BenFormRequest withholdingRate(String withholdingRate) { + public W8BenFormRequest withholdingRate(WithholdingRateEnum withholdingRate) { this.withholdingRate = withholdingRate; return this; } /** - * The withholding rate applied as per the treaty. + * 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) * @return withholdingRate */ @javax.annotation.Nullable - public String getWithholdingRate() { + public WithholdingRateEnum getWithholdingRate() { return withholdingRate; } - public void setWithholdingRate(String withholdingRate) { + public void setWithholdingRate(WithholdingRateEnum withholdingRate) { this.withholdingRate = withholdingRate; } @@ -980,6 +3702,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (!jsonObj.get("citizenshipCountry").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `citizenshipCountry` to be a primitive type in the JSON string but got `%s`", jsonObj.get("citizenshipCountry").toString())); } + // validate the required field `citizenshipCountry` + CitizenshipCountryEnum.validateJsonElement(jsonObj.get("citizenshipCountry")); if ((jsonObj.get("residenceAddress") != null && !jsonObj.get("residenceAddress").isJsonNull()) && !jsonObj.get("residenceAddress").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `residenceAddress` to be a primitive type in the JSON string but got `%s`", jsonObj.get("residenceAddress").toString())); } @@ -989,12 +3713,18 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("residenceState") != null && !jsonObj.get("residenceState").isJsonNull()) && !jsonObj.get("residenceState").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `residenceState` to be a primitive type in the JSON string but got `%s`", jsonObj.get("residenceState").toString())); } + // validate the optional field `residenceState` + if (jsonObj.get("residenceState") != null && !jsonObj.get("residenceState").isJsonNull()) { + ResidenceStateEnum.validateJsonElement(jsonObj.get("residenceState")); + } if ((jsonObj.get("residenceZip") != null && !jsonObj.get("residenceZip").isJsonNull()) && !jsonObj.get("residenceZip").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `residenceZip` to be a primitive type in the JSON string but got `%s`", jsonObj.get("residenceZip").toString())); } if (!jsonObj.get("residenceCountry").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `residenceCountry` to be a primitive type in the JSON string but got `%s`", jsonObj.get("residenceCountry").toString())); } + // validate the required field `residenceCountry` + ResidenceCountryEnum.validateJsonElement(jsonObj.get("residenceCountry")); if ((jsonObj.get("mailingAddress") != null && !jsonObj.get("mailingAddress").isJsonNull()) && !jsonObj.get("mailingAddress").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `mailingAddress` to be a primitive type in the JSON string but got `%s`", jsonObj.get("mailingAddress").toString())); } @@ -1004,12 +3734,18 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("mailingState") != null && !jsonObj.get("mailingState").isJsonNull()) && !jsonObj.get("mailingState").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `mailingState` to be a primitive type in the JSON string but got `%s`", jsonObj.get("mailingState").toString())); } + // validate the optional field `mailingState` + if (jsonObj.get("mailingState") != null && !jsonObj.get("mailingState").isJsonNull()) { + MailingStateEnum.validateJsonElement(jsonObj.get("mailingState")); + } if ((jsonObj.get("mailingZip") != null && !jsonObj.get("mailingZip").isJsonNull()) && !jsonObj.get("mailingZip").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `mailingZip` to be a primitive type in the JSON string but got `%s`", jsonObj.get("mailingZip").toString())); } if ((jsonObj.get("mailingCountry") != null && !jsonObj.get("mailingCountry").isJsonNull()) && !jsonObj.get("mailingCountry").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `mailingCountry` to be a primitive type in the JSON string but got `%s`", jsonObj.get("mailingCountry").toString())); } + // validate the required field `mailingCountry` + MailingCountryEnum.validateJsonElement(jsonObj.get("mailingCountry")); if ((jsonObj.get("tin") != null && !jsonObj.get("tin").isJsonNull()) && !jsonObj.get("tin").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `tin` to be a primitive type in the JSON string but got `%s`", jsonObj.get("tin").toString())); } @@ -1022,6 +3758,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("treatyCountry") != null && !jsonObj.get("treatyCountry").isJsonNull()) && !jsonObj.get("treatyCountry").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `treatyCountry` to be a primitive type in the JSON string but got `%s`", jsonObj.get("treatyCountry").toString())); } + // validate the optional field `treatyCountry` + if (jsonObj.get("treatyCountry") != null && !jsonObj.get("treatyCountry").isJsonNull()) { + TreatyCountryEnum.validateJsonElement(jsonObj.get("treatyCountry")); + } if ((jsonObj.get("treatyArticle") != null && !jsonObj.get("treatyArticle").isJsonNull()) && !jsonObj.get("treatyArticle").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `treatyArticle` to be a primitive type in the JSON string but got `%s`", jsonObj.get("treatyArticle").toString())); } @@ -1031,6 +3771,10 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("withholdingRate") != null && !jsonObj.get("withholdingRate").isJsonNull()) && !jsonObj.get("withholdingRate").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `withholdingRate` to be a primitive type in the JSON string but got `%s`", jsonObj.get("withholdingRate").toString())); } + // validate the optional field `withholdingRate` + if (jsonObj.get("withholdingRate") != null && !jsonObj.get("withholdingRate").isJsonNull()) { + WithholdingRateEnum.validateJsonElement(jsonObj.get("withholdingRate")); + } if ((jsonObj.get("incomeType") != null && !jsonObj.get("incomeType").isJsonNull()) && !jsonObj.get("incomeType").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `incomeType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("incomeType").toString())); }