Struct ProtoInvoiceInfo 

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

Partial information about the invoice which can be used to derive a InvoiceInfoFull

Implementations

impl<Period> ProtoInvoiceInfo<Period>

where Period: IsPeriod,

pub fn builder() -> ProtoInvoiceInfoBuilder<Period>

Create an instance of ProtoInvoiceInfo using the builder syntax

impl<Period> ProtoInvoiceInfo<Period>

where Period: IsPeriod,

pub fn offset(&self) -> &TimestampedInvoiceNumber<Period>

An offset which is used to calculate the invoice number, e.g. (237, 2025-05). This is enables us to calculate the next invoice number based on the current date and this offset.

pub fn record_of_periods_off(&self) -> &RecordOfPeriodsOff<Period>

Record of periods when we were 100% off, i.e. did not invoice for, e.g. ["2025-01", "2025-02"].

pub fn purchase_order(&self) -> &Option<PurchaseOrder>

A purchase order number associated with this invoice, e.g. "PO-12345" Typically agreed upon between the vendor and client before the invoice is issued.

pub fn footer_text(&self) -> &Option<FooterText>

E.g. “Reverse VAT according to chapter 1 2§ first section 4b in the VAT regulation.”

pub fn emphasize_color_hex(&self) -> &Option<HexColor>

Hex color code for the color emphasis of the invoice, e.g. "#e6007a".

impl<Period> ProtoInvoiceInfo<Period>

where Period: IsPeriod,

pub fn set_record_of_periods_off( &mut self, val: RecordOfPeriodsOff<Period>, ) -> &mut ProtoInvoiceInfo<Period>

Record of periods when we were 100% off, i.e. did not invoice for, e.g. ["2025-01", "2025-02"].

impl<Period> ProtoInvoiceInfo<Period>

where Period: IsPeriod,

pub fn insert_period_off(&mut self, period: Period)

Inserts a new month into the months off record. This is used to keep track of months when no invoices were issued.

Examples

extern crate klirr_core;
use klirr_core::prelude::*;
let mut invoice_info = ProtoInvoiceInfo::<YearAndMonth>::sample();
let month = YearAndMonth::may(2025);
invoice_info.insert_period_off(month);
assert!(invoice_info.record_of_periods_off().contains(&month));

impl<Period> ProtoInvoiceInfo<Period>

where Period: IsPeriod,

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

Validates the invoice information, ensuring that the offset month is not in the record of months off.

Examples

extern crate klirr_core;
use klirr_core::prelude::*;
let invoice_info = ProtoInvoiceInfo::<YearAndMonth>::sample();
assert!(invoice_info.validate().is_ok());

Trait Implementations

impl<Period> Clone for ProtoInvoiceInfo<Period>

where Period: Clone + IsPeriod,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Period> Debug for ProtoInvoiceInfo<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 ProtoInvoiceInfo<Period>

where Period: IsPeriod + Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Period> HasSample for ProtoInvoiceInfo<Period>

where Period: IsPeriod + HasSample,

fn sample() -> ProtoInvoiceInfo<Period>

Returns a sample instance of the type.

fn sample_other() -> ProtoInvoiceInfo<Period>

impl<Period> PartialEq for ProtoInvoiceInfo<Period>

where Period: PartialEq + IsPeriod,

fn eq(&self, other: &ProtoInvoiceInfo<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 ProtoInvoiceInfo<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 ProtoInvoiceInfo<Period>

where Period: IsPeriod,