Fee Detail
A fee detail record represents the full lifecycle of a fee, including its current state, associated transactions, and any waivers or reversals applied.
feeDetail Object
| Property | Data type | Description |
|---|---|---|
accountId | integer | Identifier of the account tied to the fee record. |
customerId | integer | Identifier of the customer that owns the fee record. |
feeAmount | decimal | Amount of funds the fee transaction represents. |
feeStatus | string | Current state of the fee. |
feeToApplyId | long integer (64-bit) | Helix-assigned unique ID used to relate the fee applied to the fee transaction. |
feeWaiverAmount | decimal | Amount waived for the fee. |
feeWaiverCode | string | Waiver reason or code when the fee is waived or partially waived. |
masterId | long integer (64-bit) | Transaction master identifier associated with the fee, when available. |
refundTransactionDetail | object | A feeTransactionDetail object containing detail for the refund transaction, when available. |
refundTransactionId | long integer (64-bit) | Identifier of the refund transaction when a refund has posted. |
reversalToApplyIds | array[long integer (64-bit)] | Identifiers of reversal fee work items associated with the fee. |
reversalTransactionDetails | array[object] | Array of feeTransactionDetail objects containing detail for each reversal transaction, when available. |
reversalTransactionIds | array[long integer (64-bit)] | Identifiers of reversal transactions associated with the fee. |
tag | string | Client-defined unique identifier for tracking or reconciliation. |
transactionAmount | decimal | Posted transaction amount, when available. |
transactionDetail | object | A feeTransactionDetail object containing detail for the fee transaction, when available. |
transactionId | long integer (64-bit) | Identifier of the fee transaction after it has posted. |
feeTransactionDetail Object
Represents the transaction detail associated with a fee, refund, or reversal on a feeDetail object.
| Property | Data type | Description |
|---|---|---|
accountId | integer | Identifier of the account associated with the transaction. |
amount | decimal | Amount of the transaction. |
availableDate | datetime | Date and time the transaction amount became available. |
createdDate | datetime | Date and time the transaction was created. |
customerId | integer | Identifier of the customer associated with the transaction. |
description | string | Internal description of the transaction. |
friendlyDescription | string | Customer-facing description of the transaction. |
isCredit | boolean | Indicates whether the transaction is a credit to the account. |
settledDate | datetime | Date and time the transaction settled. |
status | string | Current status of the transaction. |
subType | string | Sub-type classification of the transaction. |
tag | string | Client-defined unique identifier for tracking or reconciliation. |
transactionId | long integer (64-bit) | Identifier of the transaction. |
type | string | Type classification of the transaction. |
voidedDate | datetime | Date and time the transaction was voided, when applicable. |
Updated 4 days ago
