Struct Retainage 

pub struct Retainage {
    pub id: String,
    pub project_id: String,
    pub entity_id: String,
    pub vendor_id: String,
    pub retainage_pct: Decimal,
    pub total_held: Decimal,
    pub released_amount: Decimal,
    pub status: RetainageStatus,
    pub inception_date: NaiveDate,
    pub last_release_date: Option<NaiveDate>,
}

Retainage record — a portion of each payment withheld until project completion.

Fields

id: String

Unique retainage record ID

project_id: String

Project ID

entity_id: String

Entity ID

vendor_id: String

Vendor/subcontractor ID this retainage relates to

retainage_pct: Decimal

Retainage percentage (e.g., 0.10 for 10%)

total_held: Decimal

Total retainage held

released_amount: Decimal

Amount released to date

status: RetainageStatus

Current status

inception_date: NaiveDate

Date retainage was first held

last_release_date: Option<NaiveDate>

Date of last release (if any)

Implementations

impl Retainage

pub fn new( id: impl Into<String>, project_id: impl Into<String>, entity_id: impl Into<String>, vendor_id: impl Into<String>, retainage_pct: Decimal, inception_date: NaiveDate, ) -> Self

Creates a new retainage record.

pub fn add_from_payment(&mut self, payment_amount: Decimal)

Adds retainage from a payment.

pub fn balance_held(&self) -> Decimal

Returns the balance still held.

pub fn release(&mut self, amount: Decimal, date: NaiveDate)

Releases a specified amount.

Trait Implementations

impl Clone for Retainage

fn clone(&self) -> Retainage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Retainage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Retainage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Retainage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.