Interface: CompanyAddressSearch

Defined in: type/CompanyAddressSearch.ts:6

Object class for CompanyAddressSearch

Properties

active?

optional active?: YesNo

Defined in: type/CompanyAddressSearch.ts:44

Indicates whether the address is active

---

city

city: string

Defined in: type/CompanyAddressSearch.ts:22

Address city

---

code?

optional code?: string

Defined in: type/CompanyAddressSearch.ts:34

Address code

---

country

country: string

Defined in: type/CompanyAddressSearch.ts:26

Address country

---

createdAt

createdAt: string

Defined in: type/CompanyAddressSearch.ts:46

Date when the address was created

---

email?

optional email?: string

Defined in: type/CompanyAddressSearch.ts:32

Email that applies to this address [valid email format needed]

---

firstName?

optional firstName?: string

Defined in: type/CompanyAddressSearch.ts:10

First name the address applies to

---

id

id: number

Defined in: type/CompanyAddressSearch.ts:8

Address primary identifier

---

isDefault

isDefault: YesNo

Defined in: type/CompanyAddressSearch.ts:40

Indicates whether the address is default for its type

---

lastModifiedAt

lastModifiedAt: string

Defined in: type/CompanyAddressSearch.ts:48

Date when the address was last modified

---

lastName?

optional lastName?: string

Defined in: type/CompanyAddressSearch.ts:12

Last name the address applies to

---

mobile?

optional mobile?: string

Defined in: type/CompanyAddressSearch.ts:30

Mobile phone number that applies to this address [min: 6, max: 30]

---

name?

optional name?: string

Defined in: type/CompanyAddressSearch.ts:38

Address friendly descriptive name

---

notes?

optional notes?: string

Defined in: type/CompanyAddressSearch.ts:36

Address delivery notes

---

number?

optional number?: string

Defined in: type/CompanyAddressSearch.ts:16

Address street number

---

numberExtension?

optional numberExtension?: string

Defined in: type/CompanyAddressSearch.ts:18

Address street number extension

---

phone?

optional phone?: string

Defined in: type/CompanyAddressSearch.ts:28

Fixed phone number that applies to this address [min: 6, max: 30]

---

postalCode

postalCode: string

Defined in: type/CompanyAddressSearch.ts:20

Address postal code

---

region?

optional region?: string

Defined in: type/CompanyAddressSearch.ts:24

Address region

---

street

street: string

Defined in: type/CompanyAddressSearch.ts:14

Address street

---

type

type: AddressType

Defined in: type/CompanyAddressSearch.ts:42

Address type [one of 'home', 'delivery', 'invoice']