org.hl7.rim
public interface FinancialTransaction extends RimObject, Act
An Act representing the movement of a monetary amount between two accounts.
Discussion: Financial transactions always occur between two accounts (debit and credit), but there may be circumstances where one or both accounts are implied or inherited from the containing model.
In the "order" mood, this represents a request for a transaction to be initiated.
In the "event" mood, this represents the posting of a transaction to an account.
Examples: Cost of a service; Charge for a service; Payment of an invoice
| Method Summary | |
|---|---|
| MO | getAmt()
Gets attribute amt of type MO and cardinality 0..1.
|
| REAL | getCreditExchangeRateQuantity()
Gets attribute creditExchangeRateQuantity of type REAL and cardinality 0..1.
|
| REAL | getDebitExchangeRateQuantity()
Gets attribute debitExchangeRateQuantity of type REAL and cardinality 0..1.
|
| void | setAmt(MO value)
Sets attribute amt of type MO and cardinality 0..1.
|
| void | setCreditExchangeRateQuantity(REAL value)
Sets attribute creditExchangeRateQuantity of type REAL and cardinality 0..1.
|
| void | setDebitExchangeRateQuantity(REAL value)
Sets attribute debitExchangeRateQuantity of type REAL and cardinality 0..1.
|
Indicates the monetary amount to be transferred from the debit to the credit account.
Discussion: If the denomination of the amt differs from the denomination of the debit or credit account, then the associated exchange rate should be specified.
Returns: the attribute value
A decimal number indicating the rate of exchange in effect between the currency of the account being credited, and the currency of the transaction net amount.
Examples: For the purchase of services valued in Mexican pesos using U.S. dollars paid from a Canadian dollar account, the credit exchange ratio would be communicated as real number "r" such that "y (USD) * r = x (CAD)".
Rationale: This allows a transaction to be expressed in a currency other than that of the credit and debit accounts. It also allows the credit and debit accounts to be based in different currencies.
Returns: the attribute value
A decimal number indicating the rate of exchange in effect between the currency of the account being debited, and the currency of the transaction net amount.
Examples: For the purchase of services valued in Mexican pesos using U.S. dollars paid from a Canadian dollar account, the debit exchange ratio would be communicated as real number "r" such that "y (USD) * r = x (MXP)".
Rationale: This allows a transaction to be expressed in a currency other than that of the credit and debit accounts. It also allows the credit and debit accounts to be based in different currencies.
Returns: the attribute value
Indicates the monetary amount to be transferred from the debit to the credit account.
Discussion: If the denomination of the amt differs from the denomination of the debit or credit account, then the associated exchange rate should be specified.
Parameters: value the new attribute value
A decimal number indicating the rate of exchange in effect between the currency of the account being credited, and the currency of the transaction net amount.
Examples: For the purchase of services valued in Mexican pesos using U.S. dollars paid from a Canadian dollar account, the credit exchange ratio would be communicated as real number "r" such that "y (USD) * r = x (CAD)".
Rationale: This allows a transaction to be expressed in a currency other than that of the credit and debit accounts. It also allows the credit and debit accounts to be based in different currencies.
Parameters: value the new attribute value
A decimal number indicating the rate of exchange in effect between the currency of the account being debited, and the currency of the transaction net amount.
Examples: For the purchase of services valued in Mexican pesos using U.S. dollars paid from a Canadian dollar account, the debit exchange ratio would be communicated as real number "r" such that "y (USD) * r = x (MXP)".
Rationale: This allows a transaction to be expressed in a currency other than that of the credit and debit accounts. It also allows the credit and debit accounts to be based in different currencies.
Parameters: value the new attribute value