Skip to main content

Interface: AddressInput

Defined in: composables/react/useAddress.ts:27

Flat, framework-agnostic address payload accepted by the CRUD methods.

Properties​

city​

city: string

Defined in: composables/react/useAddress.ts:47

City. Required.

company?​

optional company?: string

Defined in: composables/react/useAddress.ts:37

Company name printed on the address.

country​

country: string

Defined in: composables/react/useAddress.ts:49

ISO country code. Required.

email?​

optional email?: string

Defined in: composables/react/useAddress.ts:51

Contact email for this address.

firstName?​

optional firstName?: string

Defined in: composables/react/useAddress.ts:31

Recipient's first name.

gender?​

optional gender?: Gender

Defined in: composables/react/useAddress.ts:57

Recipient gender.

isDefault?​

optional isDefault?: YesNo

Defined in: composables/react/useAddress.ts:59

When Y, marks this address as the default for its type.

lastName?​

optional lastName?: string

Defined in: composables/react/useAddress.ts:33

Recipient's last name.

middleName?​

optional middleName?: string

Defined in: composables/react/useAddress.ts:35

Recipient's middle name / tussenvoegsel.

mobile?​

optional mobile?: string

Defined in: composables/react/useAddress.ts:55

Mobile phone number.

notes?​

optional notes?: string

Defined in: composables/react/useAddress.ts:61

Free-text notes attached to the address.

number?​

optional number?: string

Defined in: composables/react/useAddress.ts:41

House number.

numberExtension?​

optional numberExtension?: string

Defined in: composables/react/useAddress.ts:43

House-number suffix / addition.

phone?​

optional phone?: string

Defined in: composables/react/useAddress.ts:53

Landline phone number.

postalCode​

postalCode: string

Defined in: composables/react/useAddress.ts:45

Postal / ZIP code. Required.

street​

street: string

Defined in: composables/react/useAddress.ts:39

Street name. Required.

type?​

optional type?: AddressType

Defined in: composables/react/useAddress.ts:29

Address type (invoice/delivery). Only honoured on create — defaults to invoice for companies, delivery for customers.