Database – Charges Table (charge_entity)
Description
This table holds core information about charges assessed on loans. This is the main table for charges and holds the dates amounts, etc. For information on how to use charges in the API, see API - Creating Charges.
Table Fields
Column | Data Type | Column Info | Value Notes | Other |
id | int(11) | The unique database ID of the charge. This is not the ID shown in the user interface. | ||
display_id | int(11) | The display ID of the charge. This is the ID shown in the user interface. | ||
charge_application_type | varchar(100) | The charge application type. This setting determines if the charge will come due based on it's application date, or if it won't come due, but must be paid in order to pay off the loan. | loan.pastdue.standard, loan.latefeeapp.payoff | |
past_due_setting | varchar(100) | This setting determines if the charge will be considered in the calculation of amount and days past due or not. | loan.pastdue.include, loan.pastdue.omitted | |
type | int(11) | This is the ID of the charge type. Charge types are dynamic, but a few options are hard coded. Charge types are found in the custom_charge_type_entity table. | 1 - Late Fee, 2 - Convenience Fee, 3 - NSF Fee, 4 - Repossession Fee, 5 - Other Fee | |
amount | decimal(11,2) | The amount assessed for the charge. | ||
apply_date | date | The date the charge applies to the loan. This won't necessarily be the date the charge comes due, because the fees paid by setting lets you choose to have fees come due by payment period or by date. | ||
info | varchar(255) | Additional information about the charge. This can be added by the user, but defaults to the fee type and the current date. | ||
paid_amount | decimal(11,2) | This is the dollar amount of the fee that has been paid. | ||
paid_percent | decimal(11,2) | This is the percentage of the fee that has been paid. | ||
past_due_calculation | char(30) | This field is deprecated. This was originally meant to track the fees paid by setting on an individual fee level. The setting is not tracked at a loan level. | loan.feepastduecalc.immediate, loan.feepastduecalc.date | |
interest_bearing | tinyint(1) | This setting determines whether the fee will be interest bearing. | 1 - yes, 0 - no | |
edit_comment | varchar(255) | If the charge is edited, this is a user provided comment about why the charge was edited. | ||
parent | int(11) | If the charge has been edited, the parent value is the ID of the original charge (which is no longer applying to the loan). This value will only be present on the child charge. | ||
child | int(11) | If the charge has been edited, the child value is the ID of the new (edited) charge. This value will only be present on the parent charge. | ||
active | tinyint(1) | This shows whether the charge is active. If the charge has been reversed, edited, or is no longer applying to the loan, this value will be 0. Otherwise it will be 1. | 1 - yes, 0 - no | |
deleted | tinyint(1) | This shows whether the charge has been marked as deleted. | 1 - yes, 0 - no | |
mod_id | int(11) | The ID of the loan modification the charge is associated with. If the loan has been modified, the charge will have an ID here. Otherwise this value will be NULL. | ||
entity_id | int(11) | This is the ID of the entity the charge is associated with. This should be a loan ID. Loans can be found in the loan_entity table. | ||
entity_type | varchar(100) | This is the type of the entity the charge is associated with. This will be a loan and the value will be Entity.Loan. | Entity.Loan | |
related_payment_id | int(11) | If the charge is associated with a payment (e.g. NSF Fee, Convenience Fee), this is the ID of payment with which it is associated. | ||
lastUpdated | timestamp | Timestamp of when the charge was last updated. |