Struct lexoffice::model::quotations::Address[][src]

pub struct Address {
    pub contact_id: Option<Uuid>,
    pub name: Option<String>,
    pub supplement: Option<String>,
    pub street: Option<String>,
    pub city: Option<String>,
    pub zip: Option<String>,
    pub country_code: Option<CountryCode>,
    pub contact_person: ReadOnly<String>,
}

There are two main options to address the recipient of a quotation. First, using an existing lexoffice contact or second creating a new address.

For referencing an existing contact it is only necessary to provide the UUID of that contact. Additionally, the referenced address can also be modified for this specific quotation. Therefore all required address fields must be set and the deviated address will not be stored back to the lexoffice contacts.

The referenced contact needs to have the role customer. For more information please refer to the Contacts Endpoint.

Otherwise, a new address for the quotation recipient can be created. That type of address is called a “one-time address”. A one-time address will not create a new contact in lexoffice. For instance, this could be useful when it is not needed to create a contact in lexoffice for each new quotation.

Please get in touch with us if you are not sure which option fits your use case best.

Fields

contact_id: Option<Uuid>

If the quotation recipient is (optionally) registered as a contact in lexoffice, this field specifies the related id of the contact.

name: Option<String>

The name of the quotation recipient. To use an existing contact of an individual person, provide the name in the format {firstname} {lastname}.

supplement: Option<String>

(Optional) An address supplement.

street: Option<String>

The street (street and street number) of the address.

city: Option<String>

The city of the address.

zip: Option<String>

The zip code of the address.

country_code: Option<CountryCode>

The ISO 3166 alpha2 country code of the address.

contact_person: ReadOnly<String>

The contact person selected while editing the voucher. The primary contact person will be used when creating vouchers via the API with a referenced contactId.
Read-only.

Implementations

impl Address[src]

pub fn builder() -> AddressBuilder<((), (), (), (), (), (), ())>[src]

Create a builder for building Address. On the builder, call .contact_id(...)(optional), .name(...)(optional), .supplement(...)(optional), .street(...)(optional), .city(...)(optional), .zip(...)(optional), .country_code(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Address.

Trait Implementations

impl Clone for Address[src]

impl Debug for Address[src]

impl<'de> Deserialize<'de> for Address[src]

impl PartialEq<Address> for Address[src]

impl Serialize for Address[src]

impl StructuralPartialEq for Address[src]

Auto Trait Implementations

impl RefUnwindSafe for Address

impl Send for Address

impl Sync for Address

impl Unpin for Address

impl UnwindSafe for Address

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.