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

PropertyData typeDescription
accountIdintegerIdentifier of the account tied to the fee record.
customerIdintegerIdentifier of the customer that owns the fee record.
feeAmountdecimalAmount of funds the fee transaction represents.
feeStatusstringCurrent state of the fee.
feeToApplyIdlong integer (64-bit)Helix-assigned unique ID used to relate the fee applied to the fee transaction.
feeWaiverAmountdecimalAmount waived for the fee.
feeWaiverCodestringWaiver reason or code when the fee is waived or partially waived.
masterIdlong integer (64-bit)Transaction master identifier associated with the fee, when available.
refundTransactionDetailobjectA feeTransactionDetail object containing detail for the refund transaction, when available.
refundTransactionIdlong integer (64-bit)Identifier of the refund transaction when a refund has posted.
reversalToApplyIdsarray[long integer (64-bit)]Identifiers of reversal fee work items associated with the fee.
reversalTransactionDetailsarray[object]Array of feeTransactionDetail objects containing detail for each reversal transaction, when available.
reversalTransactionIdsarray[long integer (64-bit)]Identifiers of reversal transactions associated with the fee.
tagstringClient-defined unique identifier for tracking or reconciliation.
transactionAmountdecimalPosted transaction amount, when available.
transactionDetailobjectA feeTransactionDetail object containing detail for the fee transaction, when available.
transactionIdlong 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.

PropertyData typeDescription
accountIdintegerIdentifier of the account associated with the transaction.
amountdecimalAmount of the transaction.
availableDatedatetimeDate and time the transaction amount became available.
createdDatedatetimeDate and time the transaction was created.
customerIdintegerIdentifier of the customer associated with the transaction.
descriptionstringInternal description of the transaction.
friendlyDescriptionstringCustomer-facing description of the transaction.
isCreditbooleanIndicates whether the transaction is a credit to the account.
settledDatedatetimeDate and time the transaction settled.
statusstringCurrent status of the transaction.
subTypestringSub-type classification of the transaction.
tagstringClient-defined unique identifier for tracking or reconciliation.
transactionIdlong integer (64-bit)Identifier of the transaction.
typestringType classification of the transaction.
voidedDatedatetimeDate and time the transaction was voided, when applicable.