Skip to content

Address

Source code in docs_src/capo_taxsettings/types/address.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class Address(TypedDict, closed=True):
    address_line1: "capo_taxsettings.types.address_line1.AddressLine1"
    """<p>The first line of the address. </p>"""
    address_line2: NotRequired["capo_taxsettings.types.address_line2.AddressLine2"]
    """<p>The second line of the address, if applicable. </p>"""
    address_line3: NotRequired["capo_taxsettings.types.address_line3.AddressLine3"]
    """<p> The third line of the address, if applicable. Currently, the Tax Settings API accepts the <code>addressLine3</code> parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the <code>addressLine3</code> and specify the building number for the address. For example, you might enter <code>1234</code>.</p>"""
    district_or_county: NotRequired["capo_taxsettings.types.district.District"]
    """<p>The district or county the address is located. </p> <note> <p>For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use <code>districtOrCounty</code> for the neighborhood name.</p> </note>"""
    city: "capo_taxsettings.types.city.City"
    """<p>The city that the address is in. </p>"""
    state_or_region: NotRequired["capo_taxsettings.types.state.State"]
    """<p>The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries.</p> <p>If this is required for tax settings, use the same name as shown on the <b>Tax Settings</b> page.</p>"""
    postal_code: "capo_taxsettings.types.postal_code.PostalCode"
    """<p> The postal code associated with the address. </p>"""
    country_code: "capo_taxsettings.types.country_code.CountryCode"
    """<p>The country code for the country that the address is in. </p>"""

address_line1 instance-attribute 

address_line1: AddressLine1

The first line of the address.

address_line2 instance-attribute 

address_line2: NotRequired[AddressLine2]

The second line of the address, if applicable.

address_line3 instance-attribute 

address_line3: NotRequired[AddressLine3]

The third line of the address, if applicable. Currently, the Tax Settings API accepts the addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the addressLine3 and specify the building number for the address. For example, you might enter 1234.

city instance-attribute 

city: City

The city that the address is in.

country_code instance-attribute 

country_code: CountryCode

The country code for the country that the address is in.

district_or_county instance-attribute 

district_or_county: NotRequired[District]

The district or county the address is located.

For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use districtOrCounty for the neighborhood name.

postal_code instance-attribute 

postal_code: PostalCode

The postal code associated with the address.

state_or_region instance-attribute 

state_or_region: NotRequired[State]

The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries.

If this is required for tax settings, use the same name as shown on the Tax Settings page.