Struct lexoffice::model::recurring_templates::RecurringTemplateSettings

pub struct RecurringTemplateSettings {
    pub id: ReadOnly<Uuid>,
    pub start_date: Option<Date>,
    pub end_date: Option<Date>,
    pub finalize: Option<bool>,
    pub shipping_type: Option<ShippingType>,
    pub execution_interval: Option<ExecutionInterval>,
    pub last_execution_failed: ReadOnly<bool>,
    pub last_execution_error_message: ReadOnly<String>,
    pub execution_status: ReadOnly<ExecutionStatus>,
}

Fields

id: ReadOnly<Uuid>

The id of the recurring template settings.
Read-only.

start_date: Option<Date>

(Optional) The start date of the first recurring invoice in short iso date yyyy-MM-dd. If null, recurring template is PAUSED.

end_date: Option<Date>

(Optional) The end date of the first recurring invoice in short iso date yyyy-MM-dd.

finalize: Option<bool>

Specifies the status of the invoice. If false recurring invoices are created as draft (is editable), otherwise they are finalized as open (finalized and no longer editable but yet unpaid or only partially paid). In contrast to the invoice endpoint, finalized recurring invoices will immediately and automatically be sent to the customer via email.

shipping_type: Option<ShippingType>

The same shipping types defined in the shipping conditions of invoices. Can be either one of: service, serviceperiod, delivery, deliveryperiod, none. The shipping dates/date range will be calculated automatically during execution.

execution_interval: Option<ExecutionInterval>

The execution interval defined as WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, BIANNUALLY, ANNUALLY.

last_execution_failed: ReadOnly<bool>

Whether the last execution of the recurring template was successful or not.
Read-only.

last_execution_error_message: ReadOnly<String>

Describes the problem briefly when the last execution has failed.
Read-only.

execution_status: ReadOnly<ExecutionStatus>

The status of the recurring template defined as ACTIVE, PAUSED, ENDED. Note, that there is no error state.
Read-only.

Implementations

impl RecurringTemplateSettings

pub fn builder() -> RecurringTemplateSettingsBuilder<((), (), (), (), ())>

Create a builder for building RecurringTemplateSettings. On the builder, call .start_date(...)(optional), .end_date(...)(optional), .finalize(...)(optional), .shipping_type(...)(optional), .execution_interval(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RecurringTemplateSettings.

Trait Implementations

impl Clone for RecurringTemplateSettings

fn clone(&self) -> RecurringTemplateSettings

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecurringTemplateSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RecurringTemplateSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl HasId for RecurringTemplateSettings

fn id(&self) -> &ReadOnly<Uuid>

gets the id from an object.

impl PartialEq<RecurringTemplateSettings> for RecurringTemplateSettings

fn eq(&self, other: &RecurringTemplateSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RecurringTemplateSettings) -> bool

This method tests for !=.

impl Serialize for RecurringTemplateSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RecurringTemplateSettings