pub struct AccountsReceivable { /* private fields */ }Expand description
Accounts Receivable interface.
Implementations§
Source§impl AccountsReceivable
impl AccountsReceivable
Sourcepub fn get_aging_summary(&self) -> Result<ArAgingSummary>
pub fn get_aging_summary(&self) -> Result<ArAgingSummary>
Get overall AR aging summary.
§Example
use stateset_embedded::Commerce;
let commerce = Commerce::new(":memory:")?;
let aging = commerce.accounts_receivable().get_aging_summary()?;
println!("Current: ${}", aging.current);
println!("1-30 days: ${}", aging.days_1_30);
println!("31-60 days: ${}", aging.days_31_60);
println!("61-90 days: ${}", aging.days_61_90);
println!("90+ days: ${}", aging.days_over_90);
println!("Total: ${}", aging.total);Sourcepub fn get_customer_aging(
&self,
customer_id: Uuid,
) -> Result<Option<CustomerArAging>>
pub fn get_customer_aging( &self, customer_id: Uuid, ) -> Result<Option<CustomerArAging>>
Get AR aging for a specific customer.
Sourcepub fn get_aging_report(
&self,
filter: ArAgingFilter,
) -> Result<Vec<CustomerArAging>>
pub fn get_aging_report( &self, filter: ArAgingFilter, ) -> Result<Vec<CustomerArAging>>
Get detailed AR aging report with filtering.
Sourcepub fn log_collection_activity(
&self,
input: CreateCollectionActivity,
) -> Result<CollectionActivity>
pub fn log_collection_activity( &self, input: CreateCollectionActivity, ) -> Result<CollectionActivity>
Log a collection activity (call, email, dunning letter, etc.).
§Example
use stateset_embedded::{Commerce, CreateCollectionActivity, CollectionActivityType};
use uuid::Uuid;
let commerce = Commerce::new(":memory:")?;
let activity = commerce.accounts_receivable().log_collection_activity(
CreateCollectionActivity {
invoice_id: Uuid::new_v4(),
activity_type: CollectionActivityType::PhoneCall,
notes: Some("Spoke with customer, promised to pay by Friday".into()),
contact_method: Some("Phone".into()),
contact_result: Some("Promise to pay".into()),
performed_by: Some("John Collector".into()),
..Default::default()
}
)?;Sourcepub fn list_collection_activities(
&self,
filter: CollectionActivityFilter,
) -> Result<Vec<CollectionActivity>>
pub fn list_collection_activities( &self, filter: CollectionActivityFilter, ) -> Result<Vec<CollectionActivity>>
List collection activities with filtering.
Sourcepub fn update_collection_status(
&self,
invoice_id: Uuid,
status: CollectionStatus,
) -> Result<()>
pub fn update_collection_status( &self, invoice_id: Uuid, status: CollectionStatus, ) -> Result<()>
Update the collection status of an invoice.
Sourcepub fn get_invoices_due_for_dunning(&self) -> Result<Vec<Invoice>>
pub fn get_invoices_due_for_dunning(&self) -> Result<Vec<Invoice>>
Get invoices that are due for dunning letters.
Sourcepub fn send_dunning_letter(
&self,
invoice_id: Uuid,
letter_type: DunningLetterType,
sent_by: Option<&str>,
) -> Result<CollectionActivity>
pub fn send_dunning_letter( &self, invoice_id: Uuid, letter_type: DunningLetterType, sent_by: Option<&str>, ) -> Result<CollectionActivity>
Send a dunning letter and log the activity.
§Example
use stateset_embedded::{Commerce, DunningLetterType};
use uuid::Uuid;
let commerce = Commerce::new(":memory:")?;
let activity = commerce.accounts_receivable().send_dunning_letter(
Uuid::new_v4(), // invoice_id
DunningLetterType::Reminder1,
Some("ar_system"),
)?;Sourcepub fn create_write_off(&self, input: CreateWriteOff) -> Result<WriteOff>
pub fn create_write_off(&self, input: CreateWriteOff) -> Result<WriteOff>
Create a write-off for an uncollectable invoice.
§Example
use stateset_embedded::{Commerce, CreateWriteOff, WriteOffReason};
use rust_decimal_macros::dec;
use uuid::Uuid;
let commerce = Commerce::new(":memory:")?;
let write_off = commerce.accounts_receivable().create_write_off(CreateWriteOff {
invoice_id: Uuid::new_v4(),
amount: dec!(500.00),
reason: WriteOffReason::Uncollectable,
notes: Some("Customer bankruptcy".into()),
approved_by: Some("CFO".into()),
})?;Sourcepub fn list_write_offs(&self, filter: WriteOffFilter) -> Result<Vec<WriteOff>>
pub fn list_write_offs(&self, filter: WriteOffFilter) -> Result<Vec<WriteOff>>
List write-offs with filtering.
Sourcepub fn reverse_write_off(&self, id: Uuid) -> Result<WriteOff>
pub fn reverse_write_off(&self, id: Uuid) -> Result<WriteOff>
Reverse a write-off (restore invoice to collections).
Sourcepub fn create_credit_memo(&self, input: CreateCreditMemo) -> Result<CreditMemo>
pub fn create_credit_memo(&self, input: CreateCreditMemo) -> Result<CreditMemo>
Create a credit memo for a customer.
§Example
use stateset_embedded::{Commerce, CreateCreditMemo, CreditMemoReason};
use rust_decimal_macros::dec;
use uuid::Uuid;
let commerce = Commerce::new(":memory:")?;
let memo = commerce.accounts_receivable().create_credit_memo(CreateCreditMemo {
customer_id: Uuid::new_v4(),
original_invoice_id: Some(Uuid::new_v4()),
reason: CreditMemoReason::ReturnCredit,
amount: dec!(150.00),
notes: Some("Credit for returned merchandise".into()),
})?;Sourcepub fn get_credit_memo(&self, id: Uuid) -> Result<Option<CreditMemo>>
pub fn get_credit_memo(&self, id: Uuid) -> Result<Option<CreditMemo>>
Get a credit memo by ID.
Sourcepub fn get_credit_memo_by_number(
&self,
number: &str,
) -> Result<Option<CreditMemo>>
pub fn get_credit_memo_by_number( &self, number: &str, ) -> Result<Option<CreditMemo>>
Get a credit memo by number.
Sourcepub fn list_credit_memos(
&self,
filter: CreditMemoFilter,
) -> Result<Vec<CreditMemo>>
pub fn list_credit_memos( &self, filter: CreditMemoFilter, ) -> Result<Vec<CreditMemo>>
List credit memos with filtering.
Sourcepub fn apply_credit_memo(&self, input: ApplyCreditMemo) -> Result<CreditMemo>
pub fn apply_credit_memo(&self, input: ApplyCreditMemo) -> Result<CreditMemo>
Apply a credit memo to an invoice.
Sourcepub fn void_credit_memo(&self, id: Uuid) -> Result<CreditMemo>
pub fn void_credit_memo(&self, id: Uuid) -> Result<CreditMemo>
Void a credit memo (only if not yet applied).
Sourcepub fn get_unapplied_credits(
&self,
customer_id: Uuid,
) -> Result<Vec<CreditMemo>>
pub fn get_unapplied_credits( &self, customer_id: Uuid, ) -> Result<Vec<CreditMemo>>
Get unapplied credit memos for a customer.
Sourcepub fn apply_payment_to_invoices(
&self,
input: ApplyPaymentToInvoices,
) -> Result<Vec<ArPaymentApplication>>
pub fn apply_payment_to_invoices( &self, input: ApplyPaymentToInvoices, ) -> Result<Vec<ArPaymentApplication>>
Apply a payment to one or more invoices.
§Example
use stateset_embedded::{Commerce, ApplyPaymentToInvoices, InvoicePaymentApplication};
use rust_decimal_macros::dec;
use uuid::Uuid;
let commerce = Commerce::new(":memory:")?;
let applications = commerce.accounts_receivable().apply_payment_to_invoices(
ApplyPaymentToInvoices {
payment_id: Uuid::new_v4(),
applications: vec![
InvoicePaymentApplication {
invoice_id: Uuid::new_v4(),
amount: dec!(500.00),
},
InvoicePaymentApplication {
invoice_id: Uuid::new_v4(),
amount: dec!(250.00),
},
],
}
)?;Sourcepub fn get_payment_applications(
&self,
payment_id: Uuid,
) -> Result<Vec<ArPaymentApplication>>
pub fn get_payment_applications( &self, payment_id: Uuid, ) -> Result<Vec<ArPaymentApplication>>
Get all payment applications for a payment.
Sourcepub fn unapply_payment(&self, application_id: Uuid) -> Result<()>
pub fn unapply_payment(&self, application_id: Uuid) -> Result<()>
Unapply a payment application (remove application, restore invoice balance).
Sourcepub fn get_customer_summary(
&self,
customer_id: Uuid,
) -> Result<Option<CustomerArSummary>>
pub fn get_customer_summary( &self, customer_id: Uuid, ) -> Result<Option<CustomerArSummary>>
Get AR summary for a customer.
Sourcepub fn generate_statement(
&self,
request: GenerateStatementRequest,
) -> Result<CustomerStatement>
pub fn generate_statement( &self, request: GenerateStatementRequest, ) -> Result<CustomerStatement>
Generate a customer statement.
§Example
use stateset_embedded::{Commerce, GenerateStatementRequest};
use chrono::Utc;
use uuid::Uuid;
let commerce = Commerce::new(":memory:")?;
let statement = commerce.accounts_receivable().generate_statement(
GenerateStatementRequest {
customer_id: Uuid::new_v4(),
period_start: None, // defaults to 30 days ago
period_end: None, // defaults to now
include_paid_invoices: Some(false),
}
)?;
println!("Statement for: {}", statement.customer_name);
println!("Closing balance: ${}", statement.closing_balance);Sourcepub fn get_total_outstanding(&self) -> Result<Decimal>
pub fn get_total_outstanding(&self) -> Result<Decimal>
Get total outstanding receivables.
Sourcepub fn get_average_days_to_pay(&self, customer_id: Uuid) -> Result<Option<i32>>
pub fn get_average_days_to_pay(&self, customer_id: Uuid) -> Result<Option<i32>>
Get average days to pay for a customer.
Sourcepub fn get_customers_batch(
&self,
ids: Vec<Uuid>,
) -> Result<Vec<CustomerArSummary>>
pub fn get_customers_batch( &self, ids: Vec<Uuid>, ) -> Result<Vec<CustomerArSummary>>
Get AR summary for multiple customers.