Struct Data 

pub struct Data<Period>
where
    Period: IsPeriod,
{ /* private fields */ }

The input data for the invoice, which includes information about the invoice, the vendor, and the client and the products/services included in the invoice.

Implementations

impl<Period> Data<Period>

where Period: IsPeriod,

pub fn builder() -> DataBuilder<Period>

Create an instance of Data using the builder syntax

impl<Period> Data<Period>

where Period: IsPeriod,

pub fn information(&self) -> &ProtoInvoiceInfo<Period>

Information about this specific invoice.

pub fn vendor(&self) -> &CompanyInformation

The company that issued the invoice, the vendor/seller/supplier/issuer.

pub fn client(&self) -> &CompanyInformation

The company that pays the invoice, the customer/buyer.

pub fn payment_info(&self) -> &PaymentInformation

Payment information for the vendor, used for international transfers. This includes the IBAN, bank name, and BIC. This is used to ensure that the client can pay the invoice correctly.

pub fn service_fees(&self) -> &ServiceFees

Price of service, if applicable.

pub fn expensed_periods(&self) -> &ExpensedPeriods<Period>

Any expenses that you might have incurred.

impl<Period> Data<Period>

where Period: IsPeriod,

pub fn with_client(self, val: CompanyInformation) -> Data<Period>

The company that pays the invoice, the customer/buyer.

impl<Period> Data<Period>

where Period: IsPeriod,

pub fn set_expensed_periods( &mut self, val: ExpensedPeriods<Period>, ) -> &mut Data<Period>

Any expenses that you might have incurred.

impl<Period> Data<Period>

where Period: IsPeriod,

pub fn validate(self) -> Result<Data<Period>, Error>

Validates the invoice information and returns a Result<Self>. If the information is valid, it returns Ok(self). If the information is invalid it returns an Error with the validation error.

Errors

Returns an error if the invoice information is invalid.

Examples

extern crate klirr_core;
use klirr_core::prelude::*;
let data = Data::<YearAndMonth>::sample();
let result = data.validate();
assert!(result.is_ok(), "Expected validation to succeed, got: {:?}", result);

pub fn to_partial( self, input: ValidInput, ) -> Result<DataFromDiskWithItemsOfKind<LineItemsPricedInSourceCurrency>, Error>

Converts the Data into a DataWithItemsPricedInSourceCurrency using the provided ValidInput. This method prepares the invoice data for rendering by creating an InvoiceInfoFull and populating it with the necessary information. It also calculates the invoice date, due date, and prepares the output path.

Errors

Returns an error if the month is invalid or if there are issues with retrieving expenses for the month.

Examples

extern crate klirr_core;
use klirr_core::prelude::*;
let data = Data::<YearAndMonth>::sample();
let input = ValidInput::sample();
let result = data.to_partial(input);
assert!(result.is_ok(), "Expected conversion to succeed, got: {:?}", result);

Trait Implementations

impl<Period> Clone for Data<Period>

where Period: Clone + IsPeriod,

fn clone(&self) -> Data<Period>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Period> Debug for Data<Period>

where Period: Debug + IsPeriod,

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

Formats the value using the given formatter.

impl<'de, Period> Deserialize<'de> for Data<Period>

where Period: IsPeriod + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Data<Period>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Period> HasSample for Data<Period>

where Period: IsPeriod + HasSample,

fn sample() -> Data<Period>

Returns a sample instance of the type.

fn sample_other() -> Data<Period>

impl<Period> PartialEq for Data<Period>

where Period: PartialEq + IsPeriod,

fn eq(&self, other: &Data<Period>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Period> Serialize for Data<Period>

where Period: IsPeriod + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Period> StructuralPartialEq for Data<Period>

where Period: IsPeriod,