Struct Payment 

pub struct Payment {

    pub header: DocumentHeader,
    pub payment_type: PaymentType,
    pub business_partner_id: String,
    pub is_vendor: bool,
    pub payment_method: PaymentMethod,
    pub payment_status: PaymentStatus,
    pub amount: Decimal,
    pub currency: String,
    pub house_bank: String,
    pub bank_account_id: String,
    pub partner_bank_account: Option<String>,
    pub value_date: NaiveDate,
    pub check_number: Option<String>,
    pub wire_reference: Option<String>,
    pub allocations: Vec<PaymentAllocation>,
    pub total_discount: Decimal,
    pub total_write_off: Decimal,
    pub bank_charges: Decimal,
    pub exchange_rate: Decimal,
    pub fx_gain_loss: Decimal,
    pub payment_run_id: Option<String>,
    pub is_bank_cleared: bool,
    pub bank_statement_ref: Option<String>,
    pub cleared_date: Option<NaiveDate>,
    pub is_voided: bool,
    pub void_reason: Option<String>,
}

Payment document (AP Payment or AR Receipt).

Fields

header: DocumentHeader

Document header

payment_type: PaymentType

Payment type

business_partner_id: String

Business partner ID (vendor or customer)

is_vendor: bool

Is this a vendor (true) or customer (false)?

payment_method: PaymentMethod

Payment method

payment_status: PaymentStatus

Payment status

amount: Decimal

Payment amount

currency: String

Payment currency

house_bank: String

Bank account (house bank)

bank_account_id: String

Bank account ID

partner_bank_account: Option<String>

Partner bank details

value_date: NaiveDate

Value date (when funds are available)

check_number: Option<String>

Check number (if check payment)

wire_reference: Option<String>

Wire reference

allocations: Vec<PaymentAllocation>

Allocations to invoices

total_discount: Decimal

Total discount taken

total_write_off: Decimal

Total write-off

bank_charges: Decimal

Bank charges

exchange_rate: Decimal

Exchange rate (if foreign currency)

fx_gain_loss: Decimal

FX gain/loss

payment_run_id: Option<String>

Payment run ID (if from automatic payment run)

is_bank_cleared: bool

Is this payment cleared by bank?

bank_statement_ref: Option<String>

Bank statement reference

cleared_date: Option<NaiveDate>

Cleared date

is_voided: bool

Is this payment voided?

void_reason: Option<String>

Void reason

Implementations

impl Payment

pub fn new_ap_payment( payment_id: impl Into<String>, company_code: impl Into<String>, vendor_id: impl Into<String>, amount: Decimal, fiscal_year: u16, fiscal_period: u8, payment_date: NaiveDate, created_by: impl Into<String>, ) -> Self

Create a new AP payment.

pub fn new_ar_receipt( payment_id: impl Into<String>, company_code: impl Into<String>, customer_id: impl Into<String>, amount: Decimal, fiscal_year: u16, fiscal_period: u8, payment_date: NaiveDate, created_by: impl Into<String>, ) -> Self

Create a new AR receipt.

pub fn with_payment_method(self, method: PaymentMethod) -> Self

Set payment method.

pub fn with_bank( self, house_bank: impl Into<String>, account_id: impl Into<String>, ) -> Self

Set house bank.

pub fn with_check_number(self, check_number: impl Into<String>) -> Self

Set check number.

pub fn with_value_date(self, date: NaiveDate) -> Self

Set value date.

pub fn add_allocation(&mut self, allocation: PaymentAllocation)

Add an allocation.

pub fn allocate_to_invoice( &mut self, invoice_id: impl Into<String>, invoice_type: DocumentType, amount: Decimal, discount: Decimal, )

Allocate to an invoice.

pub fn recalculate_totals(&mut self)

Recalculate totals.

pub fn total_allocated(&self) -> Decimal

Total allocated amount.

pub fn unallocated(&self) -> Decimal

Unallocated amount.

pub fn approve(&mut self, user: impl Into<String>)

Approve the payment.

pub fn send_to_bank(&mut self, user: impl Into<String>)

Send to bank.

pub fn clear(&mut self, clear_date: NaiveDate, statement_ref: impl Into<String>)

Record bank clearing.

pub fn void(&mut self, reason: impl Into<String>, user: impl Into<String>)

Void the payment.

pub fn post(&mut self, user: impl Into<String>, posting_date: NaiveDate)

Post the payment.

pub fn generate_gl_entries(&self) -> Vec<(String, Decimal, Decimal)>

Generate GL entries for payment.

Trait Implementations

impl Clone for Payment

fn clone(&self) -> Payment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Payment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Payment

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

where __S: Serializer,

Serialize this value into the given Serde serializer.