Struct WithholdingTaxRecord 

pub struct WithholdingTaxRecord {
    pub id: String,
    pub payment_id: String,
    pub vendor_id: String,
    pub withholding_type: WithholdingType,
    pub treaty_rate: Option<Decimal>,
    pub statutory_rate: Decimal,
    pub applied_rate: Decimal,
    pub base_amount: Decimal,
    pub withheld_amount: Decimal,
    pub certificate_number: Option<String>,
}

A withholding tax record associated with a cross-border payment.

Fields

id: String

Unique record identifier

payment_id: String

Payment document this withholding relates to

vendor_id: String

Vendor / payee subject to withholding

withholding_type: WithholdingType

Category of withholding

treaty_rate: Option<Decimal>

Reduced rate under an applicable tax treaty

statutory_rate: Decimal

Domestic statutory withholding rate

applied_rate: Decimal

Rate actually applied (may equal treaty_rate or statutory_rate)

base_amount: Decimal

Gross payment amount subject to withholding

withheld_amount: Decimal

Amount withheld (base_amount * applied_rate)

certificate_number: Option<String>

Tax certificate / receipt number from the authority

Implementations

impl WithholdingTaxRecord

pub fn new( id: impl Into<String>, payment_id: impl Into<String>, vendor_id: impl Into<String>, withholding_type: WithholdingType, statutory_rate: Decimal, applied_rate: Decimal, base_amount: Decimal, ) -> Self

Creates a new withholding tax record.

pub fn with_treaty_rate(self, rate: Decimal) -> Self

Sets the treaty rate.

pub fn with_certificate_number(self, number: impl Into<String>) -> Self

Sets the certificate number.

pub fn has_treaty_benefit(&self) -> bool

Returns true if a tax-treaty benefit has been applied.

A treaty benefit exists when a treaty rate is present and the applied rate is strictly less than the statutory rate.

pub fn treaty_savings(&self) -> Decimal

Computes the savings achieved through the treaty benefit.

(statutory_rate - applied_rate) * base_amount, rounded to 2 dp.

Trait Implementations

impl Clone for WithholdingTaxRecord

fn clone(&self) -> WithholdingTaxRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WithholdingTaxRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WithholdingTaxRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WithholdingTaxRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.