Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Context: Household

...

Household Action (Household Action Context)

The initial need for this new merge field coordinator and the merge fields it provides is to support Tax Credits including TIC forms/templates and the TTP template.

NameMerge Field
annualcheckbox on top of the TIC form, shows if this is an annual recertification
effdteffective date of the action initiating the TTP or TIC form
fixedRentReasonreason for household's fixed rent
hh_moveindthousehold move in date
imputedAssetIncomeimputed asset income calculated at the time the action took place
inclimitcurrent income limit of household per family size
inclimitx140current income limit of household multiplied by 140% (1.4)
initcheckbox on top of the TIC form, shows if this tenant income certification is for an initial move in
isFixedRateRentdoes the household have a fixed rate rent
maximumChargemaximum rent charge allowed
minimumChargeminimum rent charge allowed
mi_famcntcount of family members at the time of the move in
mi_inctotal income of the househole at the time of move in
speccheckbox on top of the TIC form, shows if this is a certification for a reason other than move in or annual recertification
otherdescnote field used if spec field above it set
passbookRate

imputed asset rate, currently set at 0.06% as defined by HUD

ppuCodePPU Code / account number
totalAssetIncometotal annual income from assets
totalCashValuetotal cash value of assets
totalExpenseAnnualtotal annual expenses
totalIncomeAnnualAdjustedtotal annual income, adjusted
totalIncomeOthertotal value of other income
totalIncomePensions

total value of pensions

totalIncomeWagestotal value of wages
totalIncomeWelfare total value of welfare
ttpFinalRentfinal rent charge
ttpFixedRenthousehold's fixed rent amount
ttpPercenttotal tenant payment percent
utilityAllowanceunit's utility allowance for household
u_unitNumberunit number

Tenant

Ledger 

Ledger Context

Mergefields:

"_id"

"accountRecords"

"actionId"

"closingBalances"

"closingDate"

"conveyanceDate"

"deactivatedOn"

"formattedUnitTenantStatus"

"headFirstName"

"headLastName"

"household"

"householdActions"

"moveInDate"

"moveOutDate"

"openingDate"

"ppuCode"

"program"

"programName"

"programType"

"project"

"projectName"

"projectSegmentCode"

"tenantLedgerName"

"unit"

"unitAddress"

"unitCSZ"

"unitNumber"

"unitPPUCode"

"unitSegmentCode"

"unitStreetAddress"

"unitTenantStatus"

"transactions"

"__v"

"numAccountRecords"

"sortField"

Tables:

"accountRecords"

"householdActions"

"transactions".

accountRecords
"name"

"accountDefinitionId"

"accountId"

"actionId"

"chartOfAccountsId"

"deactivatedOn"

"displayName"

"isAR"

"isPrimary"

"isBadDebt"

"isDeposit"

"isPrincipal"

"programId"

"projectId"

"unitId"

"openingBalance"

"closingBalance"

"transactionIds"



Deposit Report Context

Deposit Transactions Table
«rr_depositTransactions»/«er_depositTransactions»
«sequenceNumber»
«householdName»
«categoryName»
«subCategoryName»
«amount»

«postedOn»

«accountName»

«ppuCode»

Deposit Groups Table
«rr_depositGroups»/«er_depositGroups»
«groupName»
«groupTotal»

«subGroups»

SubGroups Table
«rr_subGroups»/«er_subGroups»
«subGroupName»
«subGroupTotal»

Non-Table Mergefields
«depositSequence»
«depositCreatedOn»

«depositPostedOn»

«depositTotal»


Receipts Context

projectedItems: { type: 'table' }

currentDueBucket

pastDueBucket1

pastDueBucket2

pastDueBucket3

lastCreditPostedOn

accountName

currentAmountDue
headFirstName

headLastName

billingDate

authorityName

authorityAddress

authorityLocation

householdStreetAddress

householdCSZ

householdLocation

sequence: type

repayRemainingBalance

ppuCode

requiredDepositsDue


Docmosis Documentation

*Don't utilize any quotes on the outside of expressions or mergefields, they're written here to emphasize it's a piece of code or an input/output. Some expressions/mergfields may utilize single or double quotes within themselves, these are okay to use and are part of the code.

Using Expressions

Sometimes an expression will work with the already existing mergefield name - you'll simply place the name of the mergefield in the expression.

Other times you may need to establish a variable for the expression to recognize it and be able to use it. In that case, to establish a variable you will place a dollar sign in front of a newly created word.

For example, we have an already existing mergefield named "applicationDate" but we need to apply an expression to it to modify it. We will establish a new variable named "application" by writing this in the top of the document (top of the document is the best place as it needs to be read by the system first before being able to be used further below in the document). That looks like this: "$application=applicationDate"  (Once again, please don't use the double quotes when you actually do this, they're there to emphasize it's code or a named variable.) This line of code will automatically be hidden by Word as long as Docmosis accepts it as an established (functioning), new variable. You will then use an expression below this line of code to augment the date from the mergefield named "applicationDate" by writing "<<{dateFormat(application, ‘MM/dd/yyyy’)}>>" now that we've established that "applicationDate" mergefield has been turned into a variable called "application". Below are some useful expressions for Doorways templates:

Formatting a Monetary Value

myVal = variable name or pre-existing mergefield.

<<myVal{renderer=number(‘$#,##0.00’)}>>

This will change an input such as "1127.4" into "$1,127.40".

If you're having an issue with a monetary amount not rounding to the 2nd decimal place, use this expression: «carbal» $<<{round(carbal,2)}>>  make sure to right click the carbal mergefield, click on Font, and press the hidden button, otherwise you will see the amount displayed twice (the expression requires that the mergefield be in the document in order to work so that's why we keep it there but hide it). 

...