Skip to main content

Module prelude

Module prelude 

Source
Expand description

Common practical finance primitive types from the focused crates.

Structs§

AccountHolderName
A non-empty account holder name.
AccountIdentifierRecord
BAI2 account identifier record.
AccountNumber
A conservatively validated bank account number.
AchCompanyId
A conservatively validated ACH company identifier.
AchEntry
Lightweight ACH entry metadata composed from validated primitives.
AchIndividualId
A conservatively validated ACH individual identifier.
AchTraceNumber
A validated 15-digit ACH trace number.
Amount
A decimal-safe amount represented as integer minor units and a decimal scale.
AppliedAmount
A receipt amount applied to open items.
Balance
An account balance.
BalanceDue
Invoice balance due.
BankAccount
A bank account with a number, type, and holder name.
Bic
A validated SWIFT/BIC-style bank identifier code.
CurrencyCode
A validated uppercase 3-letter alphabetic currency code.
CurrencyMismatch
A same-currency operation received different currencies.
DueDate
A due date in YYYY-MM-DD shape.
EffectiveDate
An effective date in YYYY-MM-DD shape.
FileHeaderRecord
BAI2 file header record.
FileTrailerRecord
BAI2 file trailer record.
FundsTypeCode
A raw BAI2 funds type code.
Iban
A validated International Bank Account Number in compact uppercase form.
Invoice
A general invoice with same-currency line totals.
InvoiceLine
A single invoice line.
InvoiceNumber
A non-empty invoice number.
JournalEntry
A balanced journal entry.
LedgerEntry
A journal entry placed into a ledger sequence.
MaskedAccountNumber
A masked bank account number intended for display.
MatchScore
A bounded deterministic match score from 0 to 10,000 basis points.
Money
A currency-safe money value.
NormalizedTransaction
A normalized transaction detail value.
Payment
A payment value with reference, amount, method, direction, and status.
PaymentReference
A non-empty payment reference.
PostedDate
A posted date in YYYY-MM-DD shape.
Posting
A single account posting.
RawRecord
A parsed BAI2 record with raw fields preserved.
Receipt
A receipt with applied and unapplied amounts.
ReceiptNumber
A non-empty receipt number.
ReceivedAt
A received timestamp stored as non-empty caller-provided text.
ReconciliationCandidate
A deterministic reconciliation candidate.
ReconciliationResult
A deterministic reconciliation result.
RoutingNumber
A validated 9-digit ABA routing number.
Subtotal
Invoice subtotal.
Total
Invoice total.
Transaction
A generic financial transaction.
TransactionDate
A transaction date in YYYY-MM-DD shape.
TransactionDetailRecord
BAI2 transaction detail record.
TransactionId
A non-empty transaction identifier.
TransactionTypeCode
A raw BAI2 transaction type code.
UnappliedAmount
A receipt amount not yet applied to open items.

Enums§

AccountType
Broad account type vocabulary.
AchAccountType
Broad ACH account type vocabulary.
AchAddendaIndicator
ACH addenda indicator vocabulary.
AchEntryDirection
ACH entry direction vocabulary.
AchError
Errors returned by ACH primitives.
AchStandardEntryClass
Conservative ACH Standard Entry Class vocabulary.
AchTransactionCode
Conservative ACH transaction-code vocabulary.
AmountError
Errors returned by amount helpers.
Bai2Error
Errors returned by BAI2 parsing and validation.
BicError
Errors returned while constructing BIC values.
CurrencyCodeError
Errors returned while constructing currency codes.
DebitCredit
Debit or credit side of a posting.
ExceptionReason
Reconciliation exception reason vocabulary.
IbanError
Errors returned while constructing IBAN values.
InvoiceStatus
Invoice lifecycle status.
MatchConfidence
Human-readable confidence band for a deterministic match score.
MatchStatus
Match lifecycle status.
MoneyError
Errors returned by money helpers.
PaymentDirection
Payment direction.
PaymentMethod
Conservative payment method vocabulary.
PaymentStatus
Payment lifecycle status.
ReceiptStatus
Receipt lifecycle status.
RecordCode
Supported BAI2 record codes.
RoutingNumberError
Errors returned while constructing routing numbers.
TransactionDirection
Generic transaction direction vocabulary.
TransactionStatus
Generic transaction status vocabulary.

Constants§

AUD
Australian dollar currency code.
CAD
Canadian dollar currency code.
EUR
Euro currency code.
GBP
British pound sterling currency code.
JPY
Japanese yen currency code.
USD
United States dollar currency code.